Endpoints
| Endpoint | Request |
|---|---|
| List Ads | GET /ads |
| Create Ad | POST /ads |
| Retrieve Ad | GET /ads/{id} |
| Update Ad | PATCH /ads/{id} |
| Delete Ad | DELETE /ads/{id} |
| Pause Ad | POST /ads/{id}/pause |
| Unpause Ad | POST /ads/{id}/unpause |
Attributes
The ad campaign this ad belongs to, an object with an id.
Properties
Properties
The referenced entity’s id.
The ad group this ad belongs to, an object with an id.
Properties
Properties
The referenced entity’s id.
Whop pixel-attributed add-to-cart events, last-click.
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_profileClicks divided by impressions, between 0 and 1.
The number of clicks.
Whop pixel-attributed complete-registration events, last-click.
Whop pixel-attributed contact events, last-click.
Spend divided by attributed add-to-cart events; null when they are not the
goal and none are attributed.
Spend divided by clicks; 0 when there are no clicks.
Spend divided by attributed complete-registration events; null when they are
not the goal and none are attributed.
Spend divided by attributed contact events; null when contacts are not the
goal and none are attributed.
Spend divided by attributed leads; null when leads are not a goal and none are
attributed.
Spend per 1,000 impressions; 0 when there are no impressions.
Spend divided by attributed purchases; null when purchases are not a goal and
none are attributed.
Spend divided by Whop pixel-attributed results; null when nothing
Whop-attributable is being optimized for.
Spend divided by attributed schedule events; null when schedules are not the
goal and none are attributed.
Spend divided by attributed submit-application events; null when they are not
the goal and none are attributed.
Spend divided by attributed view-content events; null when they are not the
goal and none are attributed.
When the ad was created, as an ISO 8601 timestamp.
The creatives used by this ad. The original/uncropped asset has a null format; square, vertical, and horizontal entries are its per-placement crops.
Properties
Properties
The placement crop this asset covers, or null for the original/uncropped asset.Available options:
square, vertical, horizontalThe creative attachment’s file id.
The kind of asset, image or video.
CDN url of the asset.
Whop pixel-attributed custom (merchant-defined) conversion events, last-click,
across all custom event names.
The description variants shown on the ad.
Platform-reported impressions divided by reach.
The headline variants shown on the ad.
Unique identifier for the ad.
The number of impressions.
Open issues affecting this ad. Empty when there are none.
Properties
Properties
Unique identifier for the issue.
A description of what the issue is and how it can be resolved.
The ID of the campaign, ad group, or ad the issue is attached to.
The type of resource the issue is attached to.Available options:
ad_campaign, ad_group, adThe instant lead form on the ad (Meta lead ads), or null when the ad group’s
conversion_location is not an instant-form destination. An object with name,
form_type (more_volume or higher_intent), an optional intro, questions, a
privacy_policy, an optional completion screen, and phone_verification.
Whop pixel-attributed leads, last-click.
The click-to-message welcome copy, an object with message and keyword, or null
when the ad has none.
Whether the ad can appear alongside other advertisers’ ads in the same unit.
Defaults to true.
The existing post this ad promotes (a Facebook post or Instagram media), or
null when it uses uploaded creatives.
The primary text variants shown in the ad body.
USD value of pixel-attributed purchases.
Whop pixel-attributed purchases, last-click.
The number of unique people who saw this.
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, customThe merchant-defined event name when result_event is custom; null for the
standard events.
Purchase value divided by spend; 0 when there is no spend.
Whop pixel-attributed schedule events, last-click.
The social accounts (Facebook page, Instagram profile) the ad runs under, each
an object with an id.
The amount charged, in spend_currency.
The ISO 4217 currency code of all monetary metrics.
The delivery status of the ad.Available options:
active, paused, in_review, rejectedWhop pixel-attributed submit-application events, last-click.
The display title of the ad. Falls back to the creative set caption when
unset.
Unique clicks divided by impressions, between 0 and 1.
The number of unique clicks.
When the ad was last updated, as an ISO 8601 timestamp.
The URL the ad links to.
Query parameters appended to the URL, as a string-to-string map.
Whop pixel-attributed view-content events, last-click.
Ad

