Endpoints
| Endpoint | Request |
|---|---|
| List Ad Groups | GET /ad_groups |
| Create Ad Group | POST /ad_groups |
| Retrieve Ad Group | GET /ad_groups/{id} |
| Update Ad Group | PATCH /ad_groups/{id} |
| Delete Ad Group | DELETE /ad_groups/{id} |
| Pause Ad Group | POST /ad_groups/{id}/pause |
| Unpause Ad Group | POST /ad_groups/{id}/unpause |
Attributes
The ad campaign this ad group belongs to, an object with an id.
Properties
Properties
The referenced entity’s id.
Whop pixel-attributed add-to-cart events, last-click.
Saved-audience targeting: { include, exclude } arrays of audience IDs.
Bid strategy.Available options:
minimum_cost, average_target, maximum_targetAd-set budget; null when the campaign owns budget (CBO).
Whether the budget is daily or 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.
The pixel event optimized for. A standard event, or any custom pixel event
name.
Where results happen: website, profile (IG/FB), messaging (DM), on_ad (engagement), or the lead destinations (instant_forms, instant_forms_and_messenger, website_and_instant_forms).Available options:
website, profile, messaging, on_ad, instant_forms, instant_forms_and_messenger, website_and_instant_formsSpend 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 group was created, ISO 8601.
Whop pixel-attributed custom (merchant-defined) conversion events, last-click,
across all custom event names.
Demographic targeting: automatic (Advantage+), age range, gender.
Target/cap cost for average_target / maximum_target.
Device targeting: platforms and operating systems.
Whether ads within this ad group have their creatives and copy dynamically AB
tested.
Schedule end, ISO 8601.
Platform-reported impressions divided by reach.
Impression cap; only valid for reach optimization.
Unique identifier for the ad group.
The number of impressions.
Open issues affecting this ad group. 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, adTargeted languages as ISO 639 codes (e.g. en, es). Region-specific Meta
locales without an ISO mapping appear as their numeric Meta locale key. Empty
= all languages.
Whop pixel-attributed leads, last-click.
For messaging destinations: the apps to message on (messenger, instagram,
whatsapp). Empty otherwise.
Daily spend floor within the budget.
What the ad group optimizes for.
Targeted placements as { platform, positions }. Empty = automatic (Advantage+) placements.
USD value of pixel-attributed purchases.
Whop pixel-attributed purchases, last-click.
The number of unique people who saw this.
Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g.
US-CA), cities, zips.
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 amount charged, in spend_currency.
The ISO 4217 currency code of all monetary metrics.
Schedule start, ISO 8601.
Delivery status of the ad group.Available options:
active, paused, rejectedWhop pixel-attributed submit-application events, last-click.
The display title of the ad group.
Unique clicks divided by impressions, between 0 and 1.
The number of unique clicks.
When the ad group was last updated, ISO 8601.
Whop pixel-attributed view-content events, last-click.
AdGroup

