Choose a version:

webPixel

query

Returns a web pixel by ID.

Anchor to Arguments

Arguments

Anchor to idid •ID: The ID of the WebPixel object to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to WebPixelWebPixel

•WebPixel

The WebPixel object enables you to manage JavaScript code snippets that run on an online store and collect behavioral data for marketing campaign optimization and analytics.

Learn how to create a web pixel extension to subscribe your app to events that are emitted by Shopify.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to settingssettings •JSON! non-null: The settings object for the web pixel. This object specifies configuration options that control the web pixel's functionality and behavior. You can find the settings for a web pixel in extensions/<your_extension_name>/shopify.extension.toml.

Was this section helpful?

Examples

Query a web pixel

Description

Retrieve a web pixel record on the store where you installed your app. This example shows how to query a web pixel's ID and [settings object](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels#step-2-define-your-web-pixel-settings).

Query

query {
  webPixel {
    id
    settings
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webPixel { id settings } }"
}'

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 {
    webPixel {
      id
      settings
    }
  }`,
  );
  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 {
    webPixel {
      id
      settings
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webPixel {
      id
      settings
    }
  }`,
});

Response

{
  "webPixel": {
    "id": "gid://shopify/WebPixel/845285844",
    "settings": "{foo2: 'bar2'}"
  }
}

Query a web pixel by its ID

Description

Retrieve a [web pixel](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels) record on the store where you installed your app.

Query

query {
  webPixel(id: "gid://shopify/WebPixel/845285844") {
    id
    settings
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webPixel(id: \"gid://shopify/WebPixel/845285844\") { id settings } }"
}'

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 {
    webPixel(id: "gid://shopify/WebPixel/845285844") {
      id
      settings
    }
  }`,
  );
  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 {
    webPixel(id: "gid://shopify/WebPixel/845285844") {
      id
      settings
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webPixel(id: "gid://shopify/WebPixel/845285844") {
      id
      settings
    }
  }`,
});

Response

{
  "webPixel": {
    "id": "gid://shopify/WebPixel/845285844",
    "settings": "{foo2: 'bar2'}"
  }
}

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 {

webPixel {

settings

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  webPixel {
    id
    settings
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webPixel { id settings } }"
}'

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 {
    webPixel {
      id
      settings
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webPixel {
      id
      settings
    }
  }`,
});

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 {
    webPixel {
      id
      settings
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"webPixel": {

"id": "gid://shopify/WebPixel/845285844",

"settings": "{foo2: 'bar2'}"

}