Skip to main content
Anchor to AnalyticsTarget

AnalyticsTarget

object

Requires read_reports access scope.

Represents a merchant-defined goal for a specific analytics metric over a date range. Merchants use analytics targets to track progress toward business objectives, such as reaching a total sales amount or a number of orders within a given period.

Each target is associated with a single metric and can optionally include filter expressions to narrow the evaluated data. Use the analyticsTargets query to retrieve targets, and the analyticsTargetCreate, analyticsTargetUpdate, and analyticsTargetsDelete mutations to manage them.

Anchor to FieldsFields

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the analytics target was created.

Anchor to currencyCodecurrencyCode
•CurrencyCode!
non-null

The currency code stored on the target's expected value. Defaults to the shop currency when the target is created.

Anchor to endDateendDate
•Date!
non-null

The end date of the period over which progress toward the target is measured.

Anchor to expectedValueexpectedValue
•Decimal!
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, shipping_country = 'US'.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to metricmetric
•String!
non-null

The identifier of the analytics metric that this target tracks, such as total_sales or orders.

Anchor to namename
•String!
non-null

A human-readable label for the target, such as Q1 Sales Target.

Anchor to presentmentExpectedValuepresentmentExpectedValue
•MoneyV2

The target's expected value converted to a specified presentment currency. Returns null when the target metric isn't a money metric or the conversion rate is unavailable.

Arguments

Anchor to currencyCodecurrencyCode
•CurrencyCode!
required

The currency code to convert the expected value into.

Anchor to shopifyqlQueryshopifyqlQuery
•String

A generated ShopifyQL query string that fetches the current value of the tracked metric for this target's date range and filters.

Anchor to startDatestartDate
•Date!
non-null

The start date of the period over which progress toward the target is measured.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time when the analytics target was last updated.

Was this section helpful?

Anchor to QueriesQueries

Anchor to analyticsTargetsanalyticsTargets
•query

Returns a paginated list of analytics targets for the shop. Each target represents a merchant-defined goal for a specific metric over a date range.

Results can be filtered by metric, name, date range, or filter expression, and sorted by fields such as start_date, expected_value, or metric.

Use the analyticsTargetCreate mutation to add new targets.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•AnalyticsTargetSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to end_date
•date

Filter by the end date of the target period.

Example:

  • end_date:2026-03-31
  • end_date:<=2026-03-31
Anchor to filters
•string

Filter by the target's filter expression.

Example:

  • filters:"shipping_country = 'US'"
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to metric
•string

Filter by metric identifier.

Example:

  • metric:total_sales
Anchor to name
•string

Filter by target name.

Example:

  • name:Q1 Sales Target
Anchor to start_date
•date

Filter by the start date of the target period.

Example:

  • start_date:2026-01-01
  • start_date:>=2026-01-01
Was this section helpful?

Anchor to MutationsMutations

Anchor to analyticsTargetCreateanalyticsTargetCreate
•mutation

Creates an analytics target that defines a merchant's goal for a specific metric over a date range. For example, a merchant can set a target of $50,000 in total sales for a quarter, or 1,000 orders in a month.

Provide the target attributes through the input argument. The target's currency is set to the shop's currency. A target is uniquely identified by the combination of metric, startDate, endDate, and filters — attempting to create a duplicate returns a user error.

Use analyticsTargetUpdate to modify an existing target, or analyticsTargetsDelete to remove targets.

Arguments

Anchor to inputinput
•AnalyticsTargetCreateInput!
required

The input fields for creating an analytics target.

Anchor to analyticsTargetUpdateanalyticsTargetUpdate
•mutation

Updates an existing analytics target. Only the fields provided in the input argument are modified; omitted fields remain unchanged. Setting a nullable field to null clears its value.

Use analyticsTargetCreate to create a new target, or analyticsTargetsDelete to remove targets.

Arguments

Anchor to idid
•ID!
required

The ID of the analytics target to update.

Anchor to inputinput
•AnalyticsTargetUpdateInput!
required

The input fields for updating an analytics target.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?