Endpoints
Attributes
string
required
Unique identifier for the ad, prefixed
ad_.object
required
The ad campaign this ad belongs to.
Properties
Properties
string
required
The referenced entity’s id.
number
required
USD value attributed to add-to-cart events. Sums the value sent with each
event, normalized to USD; events without a value contribute 0.
number
required
Whop pixel-attributed add-to-cart events, last-click.
string | null
required
The call-to-action button shown on the ad.Available options:
learn_more, shop_now, sign_up, subscribe, get_started, book_now, apply_now, contact_us, download, order_now, buy_now, get_quote, message_page, whatsapp_message, instagram_message, call_now, get_directions, send_updates, get_offer, watch_more, listen_now, play_game, open_link, no_button, get_offer_view, get_event_tickets, see_menu, request_time, event_rsvp, see_details, view_instagram_profile, donate_now, see_more, visit_sitenumber
required
Clicks divided by impressions, between 0 and 1.
number
required
The number of clicks.
number
required
USD value attributed to complete-registration events. Sums the value sent with
each event, normalized to USD; events without a value contribute 0.
number
required
Whop pixel-attributed complete-registration events, last-click.
number
required
USD value attributed to contact events. Sums the value sent with each event,
normalized to USD; events without a value contribute 0.
number
required
Whop pixel-attributed contact events, last-click.
number | null
required
Spend divided by attributed add-to-cart events; null when they are not the
goal and none are attributed.
number
required
Spend divided by clicks; 0 when there are no clicks.
number | null
required
Spend divided by attributed complete-registration events; null when they are
not the goal and none are attributed.
number | null
required
Spend divided by attributed contact events; null when contacts are not the
goal and none are attributed.
number | null
required
Spend divided by attributed leads; null when leads are not a goal and none are
attributed.
number
required
Spend per 1,000 impressions; 0 when there are no impressions.
number | null
required
Spend divided by attributed purchases; null when purchases are not a goal and
none are attributed.
number | null
required
Spend divided by Whop pixel-attributed results; null when nothing
Whop-attributable is being optimized for.
number | null
required
Spend divided by attributed schedule events; null when schedules are not the
goal and none are attributed.
number | null
required
Spend divided by attributed submit-application events; null when they are not
the goal and none are attributed.
number | null
required
Spend divided by unique clicks; null when there are no unique clicks.
number | null
required
Spend divided by attributed view-content events; null when they are not the
goal and none are attributed.
string
required
When the ad was created, as an ISO 8601 timestamp.
object[]
required
The creative assets used by this ad. The original asset has a null format; square, vertical, and horizontal entries are placement-specific variants. A carousel ad returns one format-null entry per attachment, in order.
Properties
Properties
string
required
The creative attachment’s file id.
object | null
required
The saved crop window for this creative, in source image pixels. Null for the original asset or a format that has not been cropped.
string | null
required
The placement variant this asset covers, or null for the original asset.Available options:
square, vertical, horizontalstring | null
required
Always
null. Translations are no longer available.string | null
required
The kind of asset, image or video.
string | null
required
CDN url of the asset.
number
required
Whop pixel-attributed custom (merchant-defined) conversion events, last-click,
across all custom event names.
object
required
Whop pixel-attributed custom conversions, keyed by your event name with its
last-click count as the value. Empty when no named custom events are
attributed. Custom events fired without a name are counted in
custom_conversions but omitted here, so these values sum to at most
custom_conversions.
object
required
Conversion value attributed to each custom event, keyed by event name like
custom_event_counts. Sums the value passed to whop.track, normalized to USD;
events fired without a value contribute 0.
string
required
Whether the ad is delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned.Available options:
in_appeal, rejected, in_review, draft, campaign_paused, ad_group_paused, paused, processing, issues, scheduled, learning_limited, learning, activeobject[]
required
number | null
required
Impressions divided by reach.
object[]
required
number
required
The number of impressions.
object[]
required
Open issues affecting this ad. Empty when there are none.
Properties
Properties
string
required
Unique identifier for the issue.
string
required
The kind of issue: information about delivery, a warning, or an error requiring attention.Available options:
information, warning, errorstring
required
A description of what the issue is and how it can be resolved.
string | null
required
The ID of the campaign, ad group, or ad the issue is attached to.
string
required
The type of resource the issue is attached to.Available options:
ad_campaign, ad_group, adstring
required
A short, creator-facing title for the issue.
number
required
USD value attributed to lead events. Sums the value sent with each event,
normalized to USD; events without a value contribute 0.
number
required
Whop pixel-attributed leads, last-click.
number
required
Page views on your destination from people who clicked the ad, recorded by the
Whop pixel. Counted the same way on every ad platform.
object[]
required
number
required
USD value of pixel-attributed purchases.
number
required
Whop pixel-attributed purchases, last-click.
number
required
The number of unique people who saw this.
string | null
required
The Whop pixel conversion event whose attributed count represents results — the optimization goal, or the highest-volume attributed event for campaigns that budget per ad group. Null when the goal isn’t a Whop-attributed event.Available options:
purchase, lead, schedule, submit_application, contact, complete_registration, view_content, add_to_cart, custom, messaging_conversationstring | null
required
The merchant-defined event name when result_event is custom; null for the
standard events.
number | null
required
The Whop pixel-attributed count behind result_event. When a campaign’s ad
groups optimize different goals there is no single result_event (it is null),
and this is instead the sum of each ad group’s own attributed results. Null
when nothing Whop-attributable is being optimized for.
number
required
Purchase value divided by spend, both in USD (a currency-neutral ratio); 0
when there is no spend.
number
required
USD value attributed to schedule events. Sums the value sent with each event,
normalized to USD; events without a value contribute 0.
number
required
Whop pixel-attributed schedule events, last-click.
number
required
The amount charged, in spend_currency.
string | null
required
The ISO 4217 currency code of all monetary metrics.
string
required
Whether the ad is enabled.
active and paused are set by you; in_review and rejected come from ad review.Available options: active, paused, in_review, rejectednumber
required
USD value attributed to submit-application events. Sums the value sent with
each event, normalized to USD; events without a value contribute 0.
number
required
Whop pixel-attributed submit-application events, last-click.
string | null
required
Display title of the ad.
number | null
required
Unique clicks divided by impressions, between 0 and 1.
number
required
People who clicked, reported by the Whop pixel, counted once per person.
string
required
When the ad was last updated, as an ISO 8601 timestamp.
string | null
required
The URL the ad links to, without its query string. Parameters belong in
url_parameters; any you send on url are moved there.object
required
Every query parameter appended to the URL, keyed by parameter name — including
any you sent on
url itself. Whop adds its own click-attribution parameters;
those are reserved, and setting one returns an error that names it.number
required
USD value attributed to view-content events. Sums the value sent with each
event, normalized to USD; events without a value contribute 0.
number
required
Whop pixel-attributed view-content events, last-click.
Ad