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_profilenumber
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
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:
rejected, in_review, draft, campaign_paused, ad_group_paused, paused, processing, issues, learning_limited, learning, activestring[]
required
The description variants shown on the ad.
number | null
required
Platform-reported impressions divided by reach.
string[]
required
The headline variants shown on the ad.
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
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, adobject | null
The instant lead form shown when someone taps this ad.
null when the ad group’s conversion_location is not an instant-form destination.Properties
Properties
object | null
required
Screen shown after the form is submitted.
null when the form uses the default.object | null
required
Custom consent disclaimer shown before submission.
null when the form has none.Properties
Properties
string | null
required
Disclaimer text.
object[]
required
Consent checkboxes the person can tick. Empty when the disclaimer is text-only.
string | null
required
Disclaimer title.
string
required
more_volume is quickest to submit; higher_intent adds a confirmation step before submission.Available options: more_volume, higher_intentobject | null
required
string | null
required
Internal name of the form.
boolean
required
Whether the phone number must be verified by SMS before submitting.
object | null
required
object[]
required
Questions on the form, in order.
Properties
Properties
string
Answer format for
custom questions: short_answer, multiple_choice, or
appointment. Absent otherwise.string
Question text for
custom questions. Absent for standard prefill questions.object[]
Choices for
multiple_choice questions. Absent for other formats.Properties
Properties
string | null
Stable identifier the choice’s answers are stored under. Absent for simple
choices.
object
Where the form goes when this choice is selected. Absent when the form just continues to the next question.
string
required
Choice text shown to the person.
string
required
Question type: a standard prefill type such as
email, phone, or full_name, or custom for your own question.string | null
The ad platform’s ID for the instant form the ad uses. Set when the ad
references an existing form via
lead_form_id, or once a form built from
lead_form has been created on the platform.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.
object | null
boolean
Whether the ad can appear alongside other advertisers’ ads in the same unit.
Defaults to true.
string | null
required
The existing post this ad promotes — a Facebook post or Instagram media ID.
null when the ad uses uploaded creatives.string | null
required
Identifies the network that owns
post_id; null when the ad uses uploaded creatives.Available options: facebook, instagramstring | null
required
Preview image of the existing post this ad promotes.
null for ads that use
uploaded creatives, or until the post’s media has been fetched from the
network.string[]
required
The primary text variants shown in the ad body.
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, customstring | 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.
object[]
required
The social accounts the ad runs under — its Facebook page and Instagram profile — each referenced by ID, prefixed
sacc_.Properties
Properties
string
required
The referenced entity’s id.
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.
object
required
Query parameters appended to the URL, keyed by parameter name.
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