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

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.

Was this section helpful?

Query a web pixel
Query a web pixel by its ID

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    webPixel {
7      id
8      settings
9    }
10  }`,
11);
12
13const data = await response.json();
14

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

1{
2  "webPixel": {
3    "id": "gid://shopify/WebPixel/845285844",
4    "settings": "{foo2: 'bar2'}"
5  }
6}