Skip to main content
GET
Retrieve an ad pixel

Autorisationer

Authorization
string
header
påkrævet

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

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

Ad pixel ID, prefixed adpx_.

Svar

Ad pixel

account
object
påkrævet

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

account_id
string
påkrævet

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

Eksempel:

"biz_xxxxxxxxxxxxxx"

created_at
string
påkrævet

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

Eksempel:

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

error_message
string | null
påkrævet

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

Eksempel:

null

external_id
string
påkrævet

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.

Eksempel:

"111222001"

id
string
påkrævet

Ad pixel ID, prefixed adpx_.

Eksempel:

"adpx_xxxxxxxxxxxxxx"

name
string | null
påkrævet

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

Eksempel:

"Supplier pixel"

platform
enum<string>
påkrævet

The ad platform the pixel belongs to.

Tilgængelige muligheder:
meta,
tiktok,
google,
thrad
Eksempel:

"meta"

status
enum<string>
påkrævet

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

Tilgængelige muligheder:
active,
errored,
disabled
Eksempel:

"active"

updated_at
string
påkrævet

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

Eksempel:

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