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.
Anchor to end_date •date: Filter by the end date of the target period.
Anchor to filters •string: Filter by the target's filter expression.
Anchor to id •id: Filter by id range.
Anchor to metric •string: Filter by metric identifier.
Anchor to name •string: Filter by target name.
Anchor to start_date •date: Filter by the start date of the target period.

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.

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?

Examples

Filter analytics targets by metric

Description

Retrieve analytics targets that track a specific metric using the `query` filter.

Query

query {
  analyticsTargets(first: 10, query: "metric:total_sales") {
    nodes {
      id
      name
      metric
      startDate
      endDate
      expectedValue
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { analyticsTargets(first: 10, query: \"metric:total_sales\") { nodes { id name metric startDate endDate expectedValue } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    analyticsTargets(first: 10, query: "metric:total_sales") {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    analyticsTargets(first: 10, query: "metric:total_sales") {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    analyticsTargets(first: 10, query: "metric:total_sales") {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  analyticsTargets(first: 10, query: "metric:total_sales") {
    nodes {
      id
      name
      metric
      startDate
      endDate
      expectedValue
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        analyticsTargets(first: 10, query: "metric:total_sales") {
          nodes {
            id
            name
            metric
            startDate
            endDate
            expectedValue
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "analyticsTargets": {
    "nodes": [
      {
        "id": "gid://shopify/AnalyticsTarget/96223881",
        "name": "Q1 Sales Target",
        "metric": "total_sales",
        "startDate": "2026-01-01",
        "endDate": "2026-03-31",
        "expectedValue": "1000.0"
      },
      {
        "id": "gid://shopify/AnalyticsTarget/96223936",
        "name": "January Sales Target",
        "metric": "total_sales",
        "startDate": "2025-01-01",
        "endDate": "2025-01-31",
        "expectedValue": "5000.0"
      }
    ]
  }
}

Query analytics targets for the shop

Description

Retrieve the first 10 analytics targets for the shop, sorted by start date, with the expected value converted to a presentment currency.

Query

query {
  analyticsTargets(first: 10, sortKey: START_DATE) {
    nodes {
      id
      name
      metric
      startDate
      endDate
      expectedValue
      currencyCode
      presentmentExpectedValue(currencyCode: CAD) {
        amount
        currencyCode
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { analyticsTargets(first: 10, sortKey: START_DATE) { nodes { id name metric startDate endDate expectedValue currencyCode presentmentExpectedValue(currencyCode: CAD) { amount currencyCode } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    analyticsTargets(first: 10, sortKey: START_DATE) {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
        currencyCode
        presentmentExpectedValue(currencyCode: CAD) {
          amount
          currencyCode
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    analyticsTargets(first: 10, sortKey: START_DATE) {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
        currencyCode
        presentmentExpectedValue(currencyCode: CAD) {
          amount
          currencyCode
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    analyticsTargets(first: 10, sortKey: START_DATE) {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
        currencyCode
        presentmentExpectedValue(currencyCode: CAD) {
          amount
          currencyCode
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  analyticsTargets(first: 10, sortKey: START_DATE) {
    nodes {
      id
      name
      metric
      startDate
      endDate
      expectedValue
      currencyCode
      presentmentExpectedValue(currencyCode: CAD) {
        amount
        currencyCode
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        analyticsTargets(first: 10, sortKey: START_DATE) {
          nodes {
            id
            name
            metric
            startDate
            endDate
            expectedValue
            currencyCode
            presentmentExpectedValue(currencyCode: CAD) {
              amount
              currencyCode
            }
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "analyticsTargets": {
    "nodes": [
      {
        "id": "gid://shopify/AnalyticsTarget/96223938",
        "name": "January Sales Target",
        "metric": "total_sales",
        "startDate": "2025-01-01",
        "endDate": "2025-01-31",
        "expectedValue": "5000.0",
        "currencyCode": "USD",
        "presentmentExpectedValue": {
          "amount": "6756.76",
          "currencyCode": "CAD"
        }
      },
      {
        "id": "gid://shopify/AnalyticsTarget/96223881",
        "name": "Q1 Sales Target",
        "metric": "total_sales",
        "startDate": "2026-01-01",
        "endDate": "2026-03-31",
        "expectedValue": "1000.0",
        "currencyCode": "USD",
        "presentmentExpectedValue": {
          "amount": "1351.35",
          "currencyCode": "CAD"
        }
      },
      {
        "id": "gid://shopify/AnalyticsTarget/96223939",
        "name": "Weekly Orders Target",
        "metric": "orders",
        "startDate": "2027-06-01",
        "endDate": "2027-06-07",
        "expectedValue": "100.0",
        "currencyCode": "CAD",
        "presentmentExpectedValue": null
      }
    ]
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

analyticsTargets(first: 10, query: "metric:total_sales") {

nodes {

name

metric

startDate

endDate

expectedValue

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  analyticsTargets(first: 10, query: "metric:total_sales") {
    nodes {
      id
      name
      metric
      startDate
      endDate
      expectedValue
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { analyticsTargets(first: 10, query: \"metric:total_sales\") { nodes { id name metric startDate endDate expectedValue } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    analyticsTargets(first: 10, query: "metric:total_sales") {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    analyticsTargets(first: 10, query: "metric:total_sales") {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    analyticsTargets(first: 10, query: "metric:total_sales") {
      nodes {
        id
        name
        metric
        startDate
        endDate
        expectedValue
      }
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query {
  analyticsTargets(first: 10, query: "metric:total_sales") {
    nodes {
      id
      name
      metric
      startDate
      endDate
      expectedValue
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        analyticsTargets(first: 10, query: "metric:total_sales") {
          nodes {
            id
            name
            metric
            startDate
            endDate
            expectedValue
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

JSON

{

"analyticsTargets": {

"nodes": [

{

"id": "gid://shopify/AnalyticsTarget/96223881",

"name": "Q1 Sales Target",

"metric": "total_sales",

"startDate": "2026-01-01",

"endDate": "2026-03-31",

"expectedValue": "1000.0"

{

"id": "gid://shopify/AnalyticsTarget/96223936",

"name": "January Sales Target",

"metric": "total_sales",

"startDate": "2025-01-01",

"endDate": "2025-01-31",

"expectedValue": "5000.0"

}

]

}