Anchor to AnalyticsTargetCreateInputAnalytics
input_objectAnalytics
The input fields for creating an analytics target that tracks a merchant's goal for a specific metric over a date range.
Anchor to FieldsFields
- endDate (Date!)
- expectedValue (Decimal!)
- filters (String)
- metric (String!)
- name (String!)
- startDate (Date!)
- Anchor to endDateend•Date!
Date non-null The end date of the period over which progress toward the target is measured.
- Anchor to expectedValueexpected•Decimal!
Value non-null The goal value that the merchant aims to reach for the tracked metric within the target period. Must be greater than 0.
- Anchor to filtersfilters•String
An optional filter expression to narrow the data evaluated against this target. For example,
.- Anchor to metricmetric•String!non-null
The identifier of the analytics metric that this target tracks, such as
ororders.- Anchor to namename•String!non-null
A human-readable label for the target, such as
Q1 Sales Target.- Anchor to startDatestart•Date!
Date non-null The start date of the period over which progress toward the target is measured.
Was this section helpful?