Endpoints
| Endpoint | Request |
|---|---|
| List Ad Campaigns | GET /ad_campaigns |
| Create Ad Campaign | POST /ad_campaigns |
| Retrieve Ad Campaign | GET /ad_campaigns/{id} |
| Update Ad Campaign | PATCH /ad_campaigns/{id} |
| Delete Ad Campaign | DELETE /ad_campaigns/{id} |
| Pause Ad Campaign | POST /ad_campaigns/{id}/pause |
| Unpause Ad Campaign | POST /ad_campaigns/{id}/unpause |
Attributes
Whop pixel-attributed add-to-cart events, last-click.
The bidding strategy the campaign uses.Available options:
minimum_cost, average_target, maximum_targetThe campaign budget in USD. Null when budget is set at the ad group level
(ABO).
Which level owns the budget — the campaign (CBO) or each ad group (ABO).Available options:
ad_campaign, ad_groupWhether the budget is spent per day or over the campaign’s lifetime.Available options:
daily, lifetimeClicks 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 campaign was created, as an ISO 8601 timestamp.
Whop pixel-attributed custom (merchant-defined) conversion events, last-click,
across all custom event names.
Platform-reported impressions divided by reach.
Unique identifier for the ad campaign.
The number of impressions.
Open issues affecting the campaign and its descendant ad groups and ads.
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, adWhop pixel-attributed leads, last-click.
The goal the campaign optimizes toward.Available options:
awareness, traffic, engagement, leads, salesThe specific event the campaign optimizes for. If the campaign is CBO, then
all ad groups will have the same optimization goal, which will be returned
here.
The ad network the campaign runs on.Available options:
metaUSD 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.
Regulated categories the campaign is declared under. Ads in these categories
are subject to extra targeting restrictions. Empty when none apply.
The amount charged, in spend_currency.
The ISO 4217 currency code of all monetary metrics.
The lifecycle status of the ad campaign.Available options:
active, paused, inactive, stale, pending_refund, payment_failed, draft, in_review, flagged, importing, importedWhop pixel-attributed submit-application events, last-click.
The title of the ad campaign.
Unique clicks divided by impressions, between 0 and 1.
The number of unique clicks.
When the campaign was last updated, as an ISO 8601 timestamp.
Whop pixel-attributed view-content events, last-click.
AdCampaign

