Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-13"

Body

application/json
account_id
string

Account to check. Defaults to the authenticated account.

Example:

"biz_xxxxxxxxxxxxxx"

url
string

A page to read for the pixel, e.g. an ad destination. Omit it to check the account from its events alone.

Example:

"https://shinetime.example/checkout/complete"

Response

pixel validated

firing_data_ok
boolean
required

False when the event lookup failed, meaning host_events and last_seen_days are incomplete.

Example:

true

host_events
string[]
required

Conversion event names detected on the requested page or fired recently anywhere on its hostname or final redirect hostname.

installed
boolean
required

Whether the pixel was seen. Without a url this answers for the whole account: true when it has sent events recently. With a url it answers for THAT page only — true when the page is hosted on Whop, when the page itself has sent events recently, or when the pixel was found in its source. Events the account sent from other pages do not make a given url installed.

Example:

true

last_fired_days
object
required

Event name to whole days since that event last fired, e.g. { "lead": 3 }. Carries events that fired too long ago to count as installed, so you can prompt to re-check rather than report them missing.

Example:
last_seen_days
number | null
required

Days since the pixel last sent an event, within a 30-day window. null when it hasn't sent one in that window — which includes a pixel installed moments ago.

Example:

2

native_tracking
boolean
required

True when url is hosted on Whop, so no pixel snippet is required.

Example:

false

page_events
string[]
required

Conversion event names detected on the requested page, from its recent events or its source and linked scripts.

reachable
boolean | null
required

Whether the page could be loaded. null when the request included no URL, and true when events settled the answer without a fetch.

Example:

true

url
string | null
required

The URL that was checked, after normalization. null when the request didn't include one.

Example:

"https://shinetime.example/checkout/complete"