Skip to main content
GET
Retrieve an ad pixel

Autorisations

Authorization
string
header
requis

A user OAuth token or a user API key. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

ad_pixel:manage

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Ad pixel ID, prefixed adpx_.

Réponse

Ad pixel

account
object
requis

The business whose claimed campaigns send conversions to this pixel, with its name and logo.

account_id
string
requis

The business whose claimed campaigns send conversions to this pixel, prefixed biz_.

Exemple:

"biz_xxxxxxxxxxxxxx"

created_at
string
requis

When the pixel was added, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

error_message
string | null
requis

Why the ad platform rejected the last delivery. Null unless status is errored.

Exemple:

null

external_id
string
requis

The pixel's ID on the ad platform: a Meta pixel or dataset ID, TikTok pixel code, Google Ads customer ID, or Thrad tag ID.

Exemple:

"111222001"

id
string
requis

Ad pixel ID, prefixed adpx_.

Exemple:

"adpx_xxxxxxxxxxxxxx"

name
string | null
requis

The pixel's name on the ad platform. Null when the ad platform returned none.

Exemple:

"Supplier pixel"

platform
enum<string>
requis

The ad platform the pixel belongs to.

Options disponibles:
meta,
tiktok,
google,
thrad
Exemple:

"meta"

status
enum<string>
requis

active receives conversions. errored stopped because the ad platform rejected the access token; update the token to resume. disabled was turned off by Whop.

Options disponibles:
active,
errored,
disabled
Exemple:

"active"

updated_at
string
requis

When the pixel was last changed, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"