Choose a version:

webPixel

query

Returns a web pixel by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

WebPixel

•

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.

id• ID! non-null: A globally-unique ID.
settings• 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?

Query a web pixel
Query a web pixel by its ID

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

webPixel {

settings

}

}`,

);

const data = await response.json();

query {
  webPixel {
    id
    settings
  }
}

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

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

const response = await admin.graphql(
  `#graphql
  query {
    webPixel {
      id
      settings
    }
  }`,
);

const data = await response.json();

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

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'}"

}