Sign in
Events

Validate Pixel

Checks whether the Whop pixel is installed for an account. Recent pixel events count as proof on their own, so an account that has sent data lately comes back installed without a url. Pass a url and events from that page settle it; conversion events are also read across the hostname because they commonly fire on a later confirmation page. If the requested page hasn't sent any events lately, it is fetched and read for the pixel and conversion events wired on it. installed is only true when the pixel was actually seen — in the account's events or in the page.

post/events/validate_pixel

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 read for the pixel, e.g. an ad destination. 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

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

Changed in 65 of the 74 revisions of this API.133

  • 78e1ed7366cd2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 73dd0533cd812See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 86b97292852d2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • c1dceb26e5052See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 7fcefabddb0a2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99662See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 35edb053220a2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ac2b9b1c6a002See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • a88353507eac2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 51933d70d7f52See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

Of the 74 revisions, 1 has no diff computed.