Skip to main content
Anchor to AnalyticsTargetConnection

AnalyticsTargetConnection

connection

An auto-generated type for paginating through multiple AnalyticsTargets.

Anchor to Queries with this connectionQueries with this connection

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 Possible returnsPossible returns

Anchor to edgesedges
•[AnalyticsTargetEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[AnalyticsTarget!]!
non-null

A list of nodes that are contained in AnalyticsTargetEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?