Choose a version:

analyticsTargetUpdate

mutation

Requires write_reports access scope.

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.

Anchor to Arguments

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 AnalyticsTargetUpdatePayload returnsAnalyticsTargetUpdatePayload returns

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

Was this section helpful?

Examples

Update a target's expected value and name

Description

Update the expected value and name of an existing analytics target.

Query

mutation UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
  analyticsTargetUpdate(id: $id, input: $input) {
    analyticsTarget {
      id
      name
      expectedValue
      metric
      startDate
      endDate
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/AnalyticsTarget/96223884",
  "input": {
    "name": "June Sales Target (Revised)",
    "expectedValue": "75000.00"
  }
}

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 UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) { analyticsTargetUpdate(id: $id, input: $input) { analyticsTarget { id name expectedValue metric startDate endDate } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/AnalyticsTarget/96223884",
    "input": {
      "name": "June Sales Target (Revised)",
      "expectedValue": "75000.00"
    }
  }
}'

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 UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
    analyticsTargetUpdate(id: $id, input: $input) {
      analyticsTarget {
        id
        name
        expectedValue
        metric
        startDate
        endDate
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/AnalyticsTarget/96223884",
        "input": {
            "name": "June Sales Target (Revised)",
            "expectedValue": "75000.00"
        }
    },
  },
  );
  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 UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
    analyticsTargetUpdate(id: $id, input: $input) {
      analyticsTarget {
        id
        name
        expectedValue
        metric
        startDate
        endDate
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/AnalyticsTarget/96223884",
  "input": {
    "name": "June Sales Target (Revised)",
    "expectedValue": "75000.00"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
      analyticsTargetUpdate(id: $id, input: $input) {
        analyticsTarget {
          id
          name
          expectedValue
          metric
          startDate
          endDate
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/AnalyticsTarget/96223884",
        "input": {
            "name": "June Sales Target (Revised)",
            "expectedValue": "75000.00"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
  analyticsTargetUpdate(id: $id, input: $input) {
    analyticsTarget {
      id
      name
      expectedValue
      metric
      startDate
      endDate
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/AnalyticsTarget/96223884",
  "input": {
    "name": "June Sales Target (Revised)",
    "expectedValue": "75000.00"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
        analyticsTargetUpdate(id: $id, input: $input) {
          analyticsTarget {
            id
            name
            expectedValue
            metric
            startDate
            endDate
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/AnalyticsTarget/96223884",
        "input": {
            "name": "June Sales Target (Revised)",
            "expectedValue": "75000.00"
        }
    },
  }),
});

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

Response

{
  "analyticsTargetUpdate": {
    "analyticsTarget": {
      "id": "gid://shopify/AnalyticsTarget/96223884",
      "name": "June Sales Target (Revised)",
      "expectedValue": "75000.0",
      "metric": "total_sales",
      "startDate": "2027-06-01",
      "endDate": "2027-06-30"
    },
    "userErrors": []
  }
}

analyticsTargetUpdate 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 UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {

analyticsTargetUpdate(id: $id, input: $input) {

analyticsTarget {

name

expectedValue

metric

startDate

endDate

}

userErrors {

field

message

}

}`,

{

variables: {

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

"input": {

"name": "June Sales Target (Revised)",

"expectedValue": "75000.00"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
  analyticsTargetUpdate(id: $id, input: $input) {
    analyticsTarget {
      id
      name
      expectedValue
      metric
      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 UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) { analyticsTargetUpdate(id: $id, input: $input) { analyticsTarget { id name expectedValue metric startDate endDate } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/AnalyticsTarget/96223884",
    "input": {
      "name": "June Sales Target (Revised)",
      "expectedValue": "75000.00"
    }
  }
}'

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 UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
    analyticsTargetUpdate(id: $id, input: $input) {
      analyticsTarget {
        id
        name
        expectedValue
        metric
        startDate
        endDate
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/AnalyticsTarget/96223884",
        "input": {
            "name": "June Sales Target (Revised)",
            "expectedValue": "75000.00"
        }
    },
  },
  );
  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 UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
      analyticsTargetUpdate(id: $id, input: $input) {
        analyticsTarget {
          id
          name
          expectedValue
          metric
          startDate
          endDate
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/AnalyticsTarget/96223884",
        "input": {
            "name": "June Sales Target (Revised)",
            "expectedValue": "75000.00"
        }
    },
  },
});

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 UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
    analyticsTargetUpdate(id: $id, input: $input) {
      analyticsTarget {
        id
        name
        expectedValue
        metric
        startDate
        endDate
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/AnalyticsTarget/96223884",
  "input": {
    "name": "June Sales Target (Revised)",
    "expectedValue": "75000.00"
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
  analyticsTargetUpdate(id: $id, input: $input) {
    analyticsTarget {
      id
      name
      expectedValue
      metric
      startDate
      endDate
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/AnalyticsTarget/96223884",
  "input": {
    "name": "June Sales Target (Revised)",
    "expectedValue": "75000.00"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation UpdateAnalyticsTarget($id: ID!, $input: AnalyticsTargetUpdateInput!) {
        analyticsTargetUpdate(id: $id, input: $input) {
          analyticsTarget {
            id
            name
            expectedValue
            metric
            startDate
            endDate
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/AnalyticsTarget/96223884",
        "input": {
            "name": "June Sales Target (Revised)",
            "expectedValue": "75000.00"
        }
    },
  }),
});

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

Input variables

JSON

{

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

"input": {

"name": "June Sales Target (Revised)",

"expectedValue": "75000.00"

}

Response

JSON

{

"analyticsTargetUpdate": {

"analyticsTarget": {

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

"name": "June Sales Target (Revised)",

"expectedValue": "75000.0",

"metric": "total_sales",

"startDate": "2027-06-01",

"endDate": "2027-06-30"

"userErrors": []

}