Get Storefront Pixel

GET

api

integrations

{id}

pixel

Get Storefront Pixel

curl --request GET \
  --url https://api.sequenzy.com/api/v1/integrations/{id}/pixel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/integrations/{id}/pixel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/integrations/{id}/pixel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/integrations/{id}/pixel"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/integrations/{id}/pixel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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."
}

{
  "success": false,
  "error": "Stripe has no storefront tracking pixel. Only Shopify does."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: account:read"
}

{
  "success": false,
  "error": "Integration not found"
}

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

string

required

Shopify integration ID, from List Integrations.

This endpoint takes no request body.

curl "https://api.sequenzy.com/api/v1/integrations/int_abc123/pixel" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

boolean

Whether a pixel for this app exists on the store.

string

Shopify’s pixel ID, or null when none is installed.

string

Callback URL the installed pixel posts events to.

boolean

Whether the installed pixel posts to this account’s canonical endpoint or the supported Shopify compatibility endpoint.

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.

boolean

Installed, current, and confirmed by Shopify. This is the single field to check before relying on any on-site event.

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.

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.

Fix a confirmed missing or stale pixel with Activate Storefront Pixel. Retry an unknown read before changing the store.

Responses

{
  "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."
}

{
  "success": false,
  "error": "Stripe has no storefront tracking pixel. Only Shopify does."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: account:read"
}

{
  "success": false,
  "error": "Integration not found"
}

Get Storefront Pixel

curl --request GET \
  --url https://api.sequenzy.com/api/v1/integrations/{id}/pixel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/integrations/{id}/pixel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/integrations/{id}/pixel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/integrations/{id}/pixel"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/integrations/{id}/pixel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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."
}

{
  "success": false,
  "error": "Stripe has no storefront tracking pixel. Only Shopify does."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: account:read"
}

{
  "success": false,
  "error": "Integration not found"
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Notification Preferences

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Get Storefront Pixel

Request

Response fields

Responses

​Request

​Response fields

​Responses

Request

Response fields

Responses