> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sequenzy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Storefront Pixel

> Check whether a Shopify store's tracking pixel is installed and reporting

Read the live state of a Shopify store's storefront tracking pixel.

The pixel is what produces on-site events: product views, collection views, storefront search, cart activity, and browse abandonment. Without it those events never arrive, and any sequence triggered by one silently never fires.

Nothing about the pixel is stored on the Sequenzy side. A merchant can remove it from the Shopify admin at any time, so every call reads the store directly.

Shopify only. Other providers return a `400`.

Requires an API key with the `account:read` scope.

## Request

<ParamField path="id" type="string" required>
  Shopify integration ID, from [List
  Integrations](/api-reference/integrations/list).
</ParamField>

This endpoint takes no request body.

```bash theme={null}
curl "https://api.sequenzy.com/api/v1/integrations/int_abc123/pixel" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## Response fields

<ResponseField name="pixel.installed" type="boolean">
  Whether a pixel for this app exists on the store.
</ResponseField>

<ResponseField name="pixel.id" type="string">
  Shopify's pixel ID, or `null` when none is installed.
</ResponseField>

<ResponseField name="pixel.endpoint" type="string">
  Callback URL the installed pixel posts events to.
</ResponseField>

<ResponseField name="pixel.endpointCurrent" type="boolean">
  Whether the installed pixel posts to this account's canonical endpoint or the
  supported Shopify compatibility endpoint.
</ResponseField>

<ResponseField name="pixel.configurationCurrent" type="boolean">
  Whether the endpoint and signed company, shop, and integration settings all
  match this connection. This catches a pixel whose URL looks current but whose
  events ingress would reject.
</ResponseField>

<ResponseField name="pixel.healthy" type="boolean">
  Installed, current, and confirmed by Shopify. This is the single field to
  check before relying on any on-site event.
</ResponseField>

<ResponseField name="pixel.error" type="string">
  Set when Shopify could not be reached or refused the query. `null` on a clean
  read. An error is not the same answer as "not installed" - it means the state
  is unknown.
</ResponseField>

<ResponseField name="dependentEvents" type="array">
  Event names that depend on this pixel. They are confirmed unable to arrive
  only when `pixel.error` is `null` and `pixel.healthy` is `false`; an error
  means Shopify could not confirm their state.
</ResponseField>

Fix a confirmed missing or stale pixel with [Activate Storefront Pixel](/api-reference/integrations/pixel-activate). Retry an unknown read before changing the store.

## Responses

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "integrationId": "int_abc123",
    "provider": "shopify",
    "shopDomain": "example.myshopify.com",
    "pixel": {
      "installed": true,
      "id": "gid://shopify/WebPixel/4124934472",
      "endpoint": "https://api.sequenzy.com/api/webhooks/commerce/shopify/comp_123/customer-events",
      "endpointCurrent": true,
      "configurationCurrent": true,
      "healthy": true,
      "error": null
    },
    "dependentEvents": [
      "ecommerce.product_viewed",
      "ecommerce.collection_viewed",
      "ecommerce.search_submitted",
      "ecommerce.product_added_to_cart",
      "ecommerce.cart_started",
      "ecommerce.cart_cleared",
      "ecommerce.browse_abandoned",
      "ecommerce.cart_abandoned"
    ],
    "message": "The storefront pixel is installed and reporting to this account."
  }
  ```

  ```json 400 theme={null}
  {
    "success": false,
    "error": "Stripe has no storefront tracking pixel. Only Shopify does."
  }
  ```

  ```json 401 theme={null}
  {
    "success": false,
    "error": "Unauthorized"
  }
  ```

  ```json 403 theme={null}
  {
    "success": false,
    "error": "API key is missing required scope: account:read"
  }
  ```

  ```json 404 theme={null}
  {
    "success": false,
    "error": "Integration not found"
  }
  ```
</ResponseExample>