Skip to main content
object
required
The ad campaign this ad group belongs to.
number | null
required
Budget amount in dollars.Example: 6.9
AdBudgetTypes | null
required
How the budget is allocated (daily or lifetime).Available options: daily, lifetime
number
required
Click-through rate as a fraction of impressions (clicks / impressions, 0–1).Example: 6.9
integer
required
Total clicks on this ad group’s ads in the stats window.Example: 42
number
required
Cost per click in dollars (spend / clicks). 0 when there are no clicks.Example: 6.9
number | null
required
Cost in dollars per Whop pixel-attributed lead (spend / leads). 0 when leads are tracked but none happened yet; null when leads are not a goal and none were attributed.Example: 6.9
number
required
Cost per 1,000 impressions in dollars (spend / impressions × 1000). 0 when there are no impressions.Example: 6.9
number | null
required
Cost in dollars per Whop pixel-attributed purchase (spend / purchases). 0 when purchases are tracked but none happened yet; null when purchases are not a goal and none were attributed.Example: 6.9
number | null
required
Cost in dollars per optimization result (spend / results). 0 when a result is being optimized for but none happened yet; null when nothing is being optimized for.Example: 6.9
string<date-time>
required
When the ad group was created.Example: 2023-12-01T05:00:00.401Z
number | null
required
Average number of times each person saw an ad (impressions / reach), as reported by the platform.Example: 6.9
string
required
The unique identifier for this ad group.Example: adgrp_xxxxxxxxxxxx
integer
required
Total impressions (views) on this ad group’s ads in the stats window.Example: 42
array<object>
required
Open platform issues affecting this ad group and its descendant ads, deduplicated per object. Empty when there are none.
integer
required
Number of Whop pixel-attributed leads (last-click) in the stats window.Example: 42
AdCampaignPlatforms
required
The external ad platform this ad group is running on (e.g., meta, tiktok).Available options: meta, tiktok
number
required
Total USD value of Whop pixel-attributed purchases in the stats window.Example: 6.9
integer
required
Number of Whop pixel-attributed purchases (last-click) in the stats window.Example: 42
integer
required
Unique users reached in the stats window (deduplicated by the platform).Example: 42
number
required
Return on ad spend as a ratio (purchaseValue / spend) — 2.5 means 2.50ofattributedpurchasevalueper2.50 of attributed purchase value per 1 spent. 0 when there is no spend.Example: 6.9
number
required
Amount charged in dollars in the stats window.Example: 6.9
Currencies | null
required
Currency of spend and the other monetary metric fields.Available options: usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau
AdGroupStatuses
required
Current operational status of the ad group.Available options: active, paused, inactive, in_review, rejected, flagged
string | null
required
The ad group name shown in the Whop dashboard.
number | null
required
Unique click-through rate as a fraction of impressions (unique clicks / impressions, 0–1).Example: 6.9
integer
required
Unique clicks (deduplicated by the platform) in the stats window.Example: 42
string<date-time>
required
When the ad group was last updated.Example: 2023-12-01T05:00:00.401Z