Choose a version:

analyticsTargetCreate

mutation

Requires write_reports access scope.

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.

Anchor to Arguments

Arguments

Anchor to inputinput

•AnalyticsTargetCreateInput!

required

The input fields for creating an analytics target.

Was this section helpful?

Anchor to AnalyticsTargetCreatePayload returnsAnalyticsTargetCreatePayload returns

Anchor to analyticsTargetanalyticsTarget •AnalyticsTarget: The newly created analytics target.
Anchor to userErrorsuserErrors •[AnalyticsTargetCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create a filtered orders target

Description

Create an analytics target that tracks order count for a specific channel by including a filter expression.

Query

mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
  analyticsTargetCreate(input: $input) {
    analyticsTarget {
      id
      name
      metric
      filters
      expectedValue
      startDate
      endDate
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "metric": "orders",
    "startDate": "2027-08-01",
    "endDate": "2027-08-31",
    "expectedValue": "1000.00",
    "name": "August Online Orders Target",
    "filters": "sales_channel = 'Online Store'"
  }
}

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": "mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) { analyticsTargetCreate(input: $input) { analyticsTarget { id name metric filters expectedValue startDate endDate } userErrors { field message } } }",
 "variables": {
    "input": {
      "metric": "orders",
      "startDate": "2027-08-01",
      "endDate": "2027-08-31",
      "expectedValue": "1000.00",
      "name": "August Online Orders Target",
      "filters": "sales_channel = '\''Online Store'\''"
    }
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
    analyticsTargetCreate(input: $input) {
      analyticsTarget {
        id
        name
        metric
        filters
        expectedValue
        startDate
        endDate
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "metric": "orders",
            "startDate": "2027-08-01",
            "endDate": "2027-08-31",
            "expectedValue": "1000.00",
            "name": "August Online Orders Target",
            "filters": "sales_channel = 'Online Store'"
        }
    },
  },
  );
  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
  mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
    analyticsTargetCreate(input: $input) {
      analyticsTarget {
        id
        name
        metric
        filters
        expectedValue
        startDate
        endDate
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "metric": "orders",
    "startDate": "2027-08-01",
    "endDate": "2027-08-31",
    "expectedValue": "1000.00",
    "name": "August Online Orders Target",
    "filters": "sales_channel = 'Online Store'"
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
      analyticsTargetCreate(input: $input) {
        analyticsTarget {
          id
          name
          metric
          filters
          expectedValue
          startDate
          endDate
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "metric": "orders",
            "startDate": "2027-08-01",
            "endDate": "2027-08-31",
            "expectedValue": "1000.00",
            "name": "August Online Orders Target",
            "filters": "sales_channel = 'Online Store'"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
  analyticsTargetCreate(input: $input) {
    analyticsTarget {
      id
      name
      metric
      filters
      expectedValue
      startDate
      endDate
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "input": {
    "metric": "orders",
    "startDate": "2027-08-01",
    "endDate": "2027-08-31",
    "expectedValue": "1000.00",
    "name": "August Online Orders Target",
    "filters": "sales_channel = 'Online Store'"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
        analyticsTargetCreate(input: $input) {
          analyticsTarget {
            id
            name
            metric
            filters
            expectedValue
            startDate
            endDate
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "input": {
            "metric": "orders",
            "startDate": "2027-08-01",
            "endDate": "2027-08-31",
            "expectedValue": "1000.00",
            "name": "August Online Orders Target",
            "filters": "sales_channel = 'Online Store'"
        }
    },
  }),
});

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

Response

{
  "analyticsTargetCreate": {
    "analyticsTarget": {
      "id": "gid://shopify/AnalyticsTarget/96223882",
      "name": "August Online Orders Target",
      "metric": "orders",
      "filters": "sales_channel = 'Online Store'",
      "expectedValue": "1000.0",
      "startDate": "2027-08-01",
      "endDate": "2027-08-31"
    },
    "userErrors": []
  }
}

Create a monthly sales target

Description

Create an analytics target to track progress toward a total sales goal for a one-month period.

Query

mutation CreateAnalyticsTarget($input: AnalyticsTargetCreateInput!) {
  analyticsTargetCreate(input: $input) {
    analyticsTarget {
      id
      name
      metric
      startDate
      endDate
      expectedValue
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "metric": "total_sales",
    "startDate": "2027-07-01",
    "endDate": "2027-07-31",
    "expectedValue": "50000.00",
    "name": "July Sales Target"
  }
}

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": "mutation CreateAnalyticsTarget($input: AnalyticsTargetCreateInput!) { analyticsTargetCreate(input: $input) { analyticsTarget { id name metric startDate endDate expectedValue } userErrors { field message } } }",
 "variables": {
    "input": {
      "metric": "total_sales",
      "startDate": "2027-07-01",
      "endDate": "2027-07-31",
      "expectedValue": "50000.00",
      "name": "July Sales Target"
    }
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation CreateAnalyticsTarget($input: AnalyticsTargetCreateInput!) {
    analyticsTargetCreate(input: $input) {
      analyticsTarget {
        id
        name
        metric
        startDate
        endDate
        expectedValue
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "metric": "total_sales",
            "startDate": "2027-07-01",
            "endDate": "2027-07-31",
            "expectedValue": "50000.00",
            "name": "July Sales Target"
        }
    },
  },
  );
  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
  mutation CreateAnalyticsTarget($input: AnalyticsTargetCreateInput!) {
    analyticsTargetCreate(input: $input) {
      analyticsTarget {
        id
        name
        metric
        startDate
        endDate
        expectedValue
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "metric": "total_sales",
    "startDate": "2027-07-01",
    "endDate": "2027-07-31",
    "expectedValue": "50000.00",
    "name": "July Sales Target"
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CreateAnalyticsTarget($input: AnalyticsTargetCreateInput!) {
      analyticsTargetCreate(input: $input) {
        analyticsTarget {
          id
          name
          metric
          startDate
          endDate
          expectedValue
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "metric": "total_sales",
            "startDate": "2027-07-01",
            "endDate": "2027-07-31",
            "expectedValue": "50000.00",
            "name": "July Sales Target"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation CreateAnalyticsTarget($input: AnalyticsTargetCreateInput!) {
  analyticsTargetCreate(input: $input) {
    analyticsTarget {
      id
      name
      metric
      startDate
      endDate
      expectedValue
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "input": {
    "metric": "total_sales",
    "startDate": "2027-07-01",
    "endDate": "2027-07-31",
    "expectedValue": "50000.00",
    "name": "July Sales Target"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation CreateAnalyticsTarget($input: AnalyticsTargetCreateInput!) {
        analyticsTargetCreate(input: $input) {
          analyticsTarget {
            id
            name
            metric
            startDate
            endDate
            expectedValue
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "input": {
            "metric": "total_sales",
            "startDate": "2027-07-01",
            "endDate": "2027-07-31",
            "expectedValue": "50000.00",
            "name": "July Sales Target"
        }
    },
  }),
});

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

Response

{
  "analyticsTargetCreate": {
    "analyticsTarget": {
      "id": "gid://shopify/AnalyticsTarget/96223883",
      "name": "July Sales Target",
      "metric": "total_sales",
      "startDate": "2027-07-01",
      "endDate": "2027-07-31",
      "expectedValue": "50000.0"
    },
    "userErrors": []
  }
}

analyticsTargetCreate reference

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

mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {

analyticsTargetCreate(input: $input) {

analyticsTarget {

name

metric

filters

expectedValue

startDate

endDate

}

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"metric": "orders",

"startDate": "2027-08-01",

"endDate": "2027-08-31",

"expectedValue": "1000.00",

"name": "August Online Orders Target",

"filters": "sales_channel = 'Online Store'"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
  analyticsTargetCreate(input: $input) {
    analyticsTarget {
      id
      name
      metric
      filters
      expectedValue
      startDate
      endDate
    }
    userErrors {
      field
      message
    }
  }
}

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": "mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) { analyticsTargetCreate(input: $input) { analyticsTarget { id name metric filters expectedValue startDate endDate } userErrors { field message } } }",
 "variables": {
    "input": {
      "metric": "orders",
      "startDate": "2027-08-01",
      "endDate": "2027-08-31",
      "expectedValue": "1000.00",
      "name": "August Online Orders Target",
      "filters": "sales_channel = '\''Online Store'\''"
    }
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
    analyticsTargetCreate(input: $input) {
      analyticsTarget {
        id
        name
        metric
        filters
        expectedValue
        startDate
        endDate
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "metric": "orders",
            "startDate": "2027-08-01",
            "endDate": "2027-08-31",
            "expectedValue": "1000.00",
            "name": "August Online Orders Target",
            "filters": "sales_channel = 'Online Store'"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
      analyticsTargetCreate(input: $input) {
        analyticsTarget {
          id
          name
          metric
          filters
          expectedValue
          startDate
          endDate
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "metric": "orders",
            "startDate": "2027-08-01",
            "endDate": "2027-08-31",
            "expectedValue": "1000.00",
            "name": "August Online Orders Target",
            "filters": "sales_channel = 'Online Store'"
        }
    },
  },
});

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
  mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
    analyticsTargetCreate(input: $input) {
      analyticsTarget {
        id
        name
        metric
        filters
        expectedValue
        startDate
        endDate
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "metric": "orders",
    "startDate": "2027-08-01",
    "endDate": "2027-08-31",
    "expectedValue": "1000.00",
    "name": "August Online Orders Target",
    "filters": "sales_channel = 'Online Store'"
  }
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
  analyticsTargetCreate(input: $input) {
    analyticsTarget {
      id
      name
      metric
      filters
      expectedValue
      startDate
      endDate
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "input": {
    "metric": "orders",
    "startDate": "2027-08-01",
    "endDate": "2027-08-31",
    "expectedValue": "1000.00",
    "name": "August Online Orders Target",
    "filters": "sales_channel = 'Online Store'"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation CreateFilteredTarget($input: AnalyticsTargetCreateInput!) {
        analyticsTargetCreate(input: $input) {
          analyticsTarget {
            id
            name
            metric
            filters
            expectedValue
            startDate
            endDate
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "input": {
            "metric": "orders",
            "startDate": "2027-08-01",
            "endDate": "2027-08-31",
            "expectedValue": "1000.00",
            "name": "August Online Orders Target",
            "filters": "sales_channel = 'Online Store'"
        }
    },
  }),
});

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

Input variables

JSON

{

"input": {

"metric": "orders",

"startDate": "2027-08-01",

"endDate": "2027-08-31",

"expectedValue": "1000.00",

"name": "August Online Orders Target",

"filters": "sales_channel = 'Online Store'"

}

Response

JSON

{

"analyticsTargetCreate": {

"analyticsTarget": {

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

"name": "August Online Orders Target",

"metric": "orders",

"filters": "sales_channel = 'Online Store'",

"expectedValue": "1000.0",

"startDate": "2027-08-01",

"endDate": "2027-08-31"

"userErrors": []

}