Events

Validate Pixel

Changed on

Checks whether the Whop pixel is installed for an account, or on one page when you pass a url. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live.

post/events/validate_pixel

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/events/validate_pixel
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

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

Request body

account_idstring

Account to check. Defaults to the authenticated account.

urlstring

A page to check for the pixel, such as an ad destination. Events from that page settle the answer; if it hasn't sent any lately, it is fetched and its source read for the pixel and the conversion events wired on it. Omit it to check the account from its events alone.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "url": "https://shinetime.example/checkout/complete"
}

Response

pixel validated

affiliate_tracking_detectedboolean required

Whether an affiliate tracking SDK was found on the page at url. Supported platforms: Everflow.

firing_data_okboolean required

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

host_eventsstring[] required
installedboolean 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.

last_fired_daysobject 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.

last_seen_daysnumber nullable 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.

native_trackingboolean required

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

page_eventsstring[] required
reachableboolean nullable required

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

urlstring nullable required

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

Example response

{
  "firing_data_ok": true,
  "host_events": [
    "lead"
  ],
  "last_fired_days": {
    "lead": 2
  },
  "last_seen_days": 2,
  "page_events": [
    "lead"
  ],
  "reachable": true,
  "url": "https://shinetime.example/"
}

Changes

  • 507636677fe9Revision changes
    • info

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

  • c3b5561c6176Revision changes
    • info

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth