Choose a version:

analyticsTargetsDelete

mutation

Requires write_reports access scope.

Deletes one or more analytics targets. Accepts a list of target IDs and returns the IDs that were successfully deleted. If any ID is not found, a user error is returned for that ID while the remaining valid targets are still deleted.

Use analyticsTargetCreate to create new targets, or analyticsTargetUpdate to modify existing ones.

Anchor to Arguments

Arguments

Anchor to idsids •[ID!]! required: The IDs of the analytics targets to delete.

Was this section helpful?

Anchor to AnalyticsTargetsDeletePayload returnsAnalyticsTargetsDeletePayload returns

Anchor to deletedIdsdeletedIds •[ID!]: The IDs of the deleted analytics targets.
Anchor to userErrorsuserErrors •[AnalyticsTargetsDeleteUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Delete analytics targets

Description

Delete one or more analytics targets by their IDs. The mutation returns the IDs of the successfully deleted targets and any errors for targets that could not be found.

Query

mutation DeleteAnalyticsTargets($ids: [ID!]!) {
  analyticsTargetsDelete(ids: $ids) {
    deletedIds
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "ids": [
    "gid://shopify/AnalyticsTarget/96223935"
  ]
}

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 DeleteAnalyticsTargets($ids: [ID!]!) { analyticsTargetsDelete(ids: $ids) { deletedIds userErrors { field message } } }",
 "variables": {
    "ids": [
      "gid://shopify/AnalyticsTarget/96223935"
    ]
  }
}'

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 DeleteAnalyticsTargets($ids: [ID!]!) {
    analyticsTargetsDelete(ids: $ids) {
      deletedIds
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "ids": [
            "gid://shopify/AnalyticsTarget/96223935"
        ]
    },
  },
  );
  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 DeleteAnalyticsTargets($ids: [ID!]!) {
    analyticsTargetsDelete(ids: $ids) {
      deletedIds
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "ids": [
    "gid://shopify/AnalyticsTarget/96223935"
  ]
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteAnalyticsTargets($ids: [ID!]!) {
      analyticsTargetsDelete(ids: $ids) {
        deletedIds
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "ids": [
            "gid://shopify/AnalyticsTarget/96223935"
        ]
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation DeleteAnalyticsTargets($ids: [ID!]!) {
  analyticsTargetsDelete(ids: $ids) {
    deletedIds
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "ids": [
    "gid://shopify/AnalyticsTarget/96223935"
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation DeleteAnalyticsTargets($ids: [ID!]!) {
        analyticsTargetsDelete(ids: $ids) {
          deletedIds
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "ids": [
            "gid://shopify/AnalyticsTarget/96223935"
        ]
    },
  }),
});

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

Response

{
  "analyticsTargetsDelete": {
    "deletedIds": [
      "gid://shopify/AnalyticsTarget/96223935"
    ],
    "userErrors": []
  }
}

analyticsTargetsDelete 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 DeleteAnalyticsTargets($ids: [ID!]!) {

analyticsTargetsDelete(ids: $ids) {

deletedIds

userErrors {

field

message

}

}`,

{

variables: {

"ids": [

"gid://shopify/AnalyticsTarget/96223935"

]

);

const json = await response.json();

return json.data;

}

GQL

mutation DeleteAnalyticsTargets($ids: [ID!]!) {
  analyticsTargetsDelete(ids: $ids) {
    deletedIds
    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 DeleteAnalyticsTargets($ids: [ID!]!) { analyticsTargetsDelete(ids: $ids) { deletedIds userErrors { field message } } }",
 "variables": {
    "ids": [
      "gid://shopify/AnalyticsTarget/96223935"
    ]
  }
}'

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 DeleteAnalyticsTargets($ids: [ID!]!) {
    analyticsTargetsDelete(ids: $ids) {
      deletedIds
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "ids": [
            "gid://shopify/AnalyticsTarget/96223935"
        ]
    },
  },
  );
  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 DeleteAnalyticsTargets($ids: [ID!]!) {
      analyticsTargetsDelete(ids: $ids) {
        deletedIds
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "ids": [
            "gid://shopify/AnalyticsTarget/96223935"
        ]
    },
  },
});

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 DeleteAnalyticsTargets($ids: [ID!]!) {
    analyticsTargetsDelete(ids: $ids) {
      deletedIds
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "ids": [
    "gid://shopify/AnalyticsTarget/96223935"
  ]
}

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

Shopify CLI

shopify app execute \
--query \
'mutation DeleteAnalyticsTargets($ids: [ID!]!) {
  analyticsTargetsDelete(ids: $ids) {
    deletedIds
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "ids": [
    "gid://shopify/AnalyticsTarget/96223935"
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation DeleteAnalyticsTargets($ids: [ID!]!) {
        analyticsTargetsDelete(ids: $ids) {
          deletedIds
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "ids": [
            "gid://shopify/AnalyticsTarget/96223935"
        ]
    },
  }),
});

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

Input variables

JSON

{

"ids": [

"gid://shopify/AnalyticsTarget/96223935"

]

}

Response

JSON

{

"analyticsTargetsDelete": {

"deletedIds": [

"gid://shopify/AnalyticsTarget/96223935"

"userErrors": []

}