v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB

Integrations

Get storefront pixel state

Reads the live state of a Shopify store's storefront tracking pixel. Nothing about the pixel is stored locally, so this queries the store on every call. A confirmed missing or stale pixel prevents on-site events (product views, cart activity, browse abandonment) from arriving; a Shopify read error reports the state as unknown instead. Shopify only. Requires the account:read scope.

get/integrations/{id}/pixel

Path parameters

idstring required

Shopify integration ID.

Response

Pixel state

successboolean

integrationIdstring

providerstring

shopDomainstring

dependentEventsstring[]

Event names that depend on this pixel. They are confirmed unable to arrive only when pixel.error is null and pixel.healthy is false.

messagestring

Example response

{
  "success": true,
  "provider": "shopify",
  "shopDomain": "example.myshopify.com"
}