Access tokens1

Account links1

Accounts15

Ad Campaigns9

Ad Conversion Value Rules7

Ad Groups10

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps8

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Cashback Rules4

Chat channels3

Checkout Configurations4

Company token transactions3

Confirmation Tokens1

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes6

Dm channels5

Dm members5

Domains5

Economic Intelligence2

Events4

Experiences8

Experiments8

Exports3

Fee markups3

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members3

Memberships11

Messages5

Notifications6

Partner Referral Requests6

Partners7

Payment Method Domains5

Payment methods3

Payment Rules9

Payments12

Payout accounts1

Payout methods2

Payouts10

People2

Permissions1

Plans6

Products7

Promo Codes6

Reactions4

Refunds2

Resolution Center Cases11

Reviews2

Setup Intents6

Shipments4

Social Accounts7

Stats2

Support channels3

Swaps4

Team Members5

Topups1

Trades5

Transfers4

Users18

Verifications4

Waitlist Entries7

Webhooks9

Webhooks

Accounts3

Ad Campaigns2

Ads1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Ledgers1

Members2

Memberships4

Messages1

Payments7

Payout accounts1

Payouts4

Plans3

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup Intents3

Shipments2

Swaps1

Transfers3

Verifications2

Ad Groups

Retrieve an Ad Group

Retrieves a single ad group.

get/ad_groups/{id}

Query parameters

stats_fromstring

Start of the stats window.

stats_tostring

End of the stats window.

time_zonestring

IANA timezone the stats window is interpreted in. Defaults to UTC.

attribution_model'last_touch' | 'first_touch'

Attribution model the conversion stats count under (defaults to last_touch). Under both models a journey with any whop ad touch attributes to whop; the model picks which whop touch credits the entity and which non-whop source wins otherwise.

Response

ad group retrieved

added_to_cart_valuenumber 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.

added_to_cartsnumber required

Whop pixel-attributed add-to-cart events, last-click.

bid_type'minimum_cost' | 'average_target' | 'maximum_target' | 'null' nullable required

How delivery bids are set in the ad auction. Target-based strategies use desired_cost_per_result.

budget_amountnumber nullable required

This ad group's budget in USD, which is what it is stored and billed in. null when the budget is set on the campaign instead.

budget_amount_localnumber nullable required

The same budget stated in budget_currency at today's exchange rate, for display in the account's ads reporting currency. null when budget_amount is.

budget_currencystring required

The ISO 4217 code budget_amount_local is in: the account's ads_reporting_currency preference. usd unless the account changed it.

budget_type'daily' | 'lifetime' | 'null' nullable required

Whether budget_amount is spent per day (daily) or over the ad group's full run (lifetime). A lifetime ad group also needs ends_at, at least 24 hours after it starts.

click_through_ratenumber required

Clicks divided by impressions, between 0 and 1.

clicksnumber required

The number of clicks.

completed_registration_valuenumber required

USD value attributed to complete-registration events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

completed_registrationsnumber required

Whop pixel-attributed complete-registration events, last-click.

contact_valuenumber required

USD value attributed to contact events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

contactsnumber required

Whop pixel-attributed contact events, last-click.

Where the outcome being optimized for occurs, such as a website visit, social-profile visit, messaging conversation, ad interaction, or lead-form submission.

cost_per_added_to_cartnumber nullable required

Spend divided by attributed add-to-cart events; null when they are not the goal and none are attributed.

cost_per_clicknumber required

Spend divided by clicks; 0 when there are no clicks.

cost_per_completed_registrationnumber nullable required

Spend divided by attributed complete-registration events; null when they are not the goal and none are attributed.

cost_per_contactnumber nullable required

Spend divided by attributed contact events; null when contacts are not the goal and none are attributed.

cost_per_leadnumber nullable required

Spend divided by attributed leads; null when leads are not a goal and none are attributed.

cost_per_millenumber required

Spend per 1,000 impressions; 0 when there are no impressions.

cost_per_purchasenumber nullable required

Spend divided by attributed purchases; null when purchases are not a goal and none are attributed.

cost_per_resultnumber nullable required

Spend divided by Whop pixel-attributed results; null when nothing Whop-attributable is being optimized for.

cost_per_schedulenumber nullable required

Spend divided by attributed schedule events; null when schedules are not the goal and none are attributed.

cost_per_submitted_applicationnumber nullable required

Spend divided by attributed submit-application events; null when they are not the goal and none are attributed.

cost_per_unique_clicknumber nullable required

Spend divided by unique clicks; null when there are no unique clicks.

cost_per_viewed_contentnumber nullable required

Spend divided by attributed view-content events; null when they are not the goal and none are attributed.

created_atstring required

When the ad group was created, as an ISO 8601 timestamp.

custom_conversionsnumber required

Whop pixel-attributed custom (merchant-defined) conversion events, last-click, across all custom event names.

custom_event_countsobject 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.

custom_event_valuesobject 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.

Whether ads in this ad group are delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned.

desired_cost_per_resultnumber nullable required

Cost per result to aim for (average_target) or never exceed (maximum_target). null for minimum_cost bidding.

dynamic_creativeboolean

Whether the ad platform automatically mixes and matches this ad group's creatives and copy to find the best-performing combinations.

ends_atstring nullable required

When the ad group stops delivering, as an ISO 8601 timestamp. null when it runs until paused.

frequencynumber nullable required

Platform-reported impressions divided by reach.

idstring required

Unique identifier for the ad group, prefixed adgrp_.

impressionsnumber required

The number of impressions.

languagesstring[] required

lead_valuenumber required

USD value attributed to lead events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

leadsnumber required

Whop pixel-attributed leads, last-click.

link_clicksnumber required

Clicks on links in the ad that lead to your destination, as reported by the ad platform. A subset of clicks, which also counts likes, comments, and other interactions with the ad.

message_appsstring[]

minimum_daily_spendnumber nullable

Minimum the ad group tries to spend each day. null when no floor is set.

The result the ad group's delivery is optimized to get the most of.

platform'meta' | 'tiktok' | 'google' required

The ad platform this ad group runs on.

purchase_valuenumber required

USD value of pixel-attributed purchases.

purchasesnumber required

Whop pixel-attributed purchases, last-click.

reachnumber required

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.

result_event_namestring nullable required

The merchant-defined event name when result_event is custom; null for the standard events.

resultsnumber nullable 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.

return_on_ad_spendnumber required

Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when there is no spend.

schedule_valuenumber required

USD value attributed to schedule events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

schedulesnumber required

Whop pixel-attributed schedule events, last-click.

spendnumber required

The amount charged, in spend_currency.

spend_currencystring nullable required

The ISO 4217 currency code of all monetary metrics.

starts_atstring nullable required

When the ad group starts delivering, as an ISO 8601 timestamp. null when it starts as soon as it's active.

status'active' | 'paused' | 'rejected' | 'duplicating' required

Whether the ad group is enabled. active and paused are set by you; rejected means it failed ad review; duplicating is a copy still being filled in.

submitted_application_valuenumber required

USD value attributed to submit-application events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

submitted_applicationsnumber required

Whop pixel-attributed submit-application events, last-click.

titlestring nullable required

Display name of the ad group.

unique_click_through_ratenumber nullable required

Unique clicks divided by impressions, between 0 and 1.

unique_clicksnumber required

People who clicked, reported by the Whop pixel, counted once per person.

updated_atstring required

When the ad group was last updated, as an ISO 8601 timestamp.

viewed_content_valuenumber required

USD value attributed to view-content events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

viewed_contentsnumber required

Whop pixel-attributed view-content events, last-click.

Example response

{
  "ad_campaign": {
    "id": "adcamp_xxxxxxxxxxxxxx"
  },
  "added_to_cart_value": 12650,
  "added_to_carts": 165,
  "audiences": {
    "exclude": [
      "adaud_xxxxxxxxxxxxxx"
    ],
    "include": [
      "adaud_xxxxxxxxxxxxxx"
    ]
  },
  "bid_type": "average_target",
  "budget_amount": 60,
  "budget_amount_local": 60,
  "budget_currency": "usd",
  "budget_type": "daily",
  "click_through_rate": 0.025,
  "clicks": 5500,
  "completed_registration_value": 1650,
  "completed_registrations": 55,
  "contact_value": 2640,
  "contacts": 88,
  "conversion_event": "purchase",
  "conversion_location": "website",
  "cost_per_added_to_cart": 8,
  "cost_per_click": 0.24,
  "cost_per_completed_registration": 24,
  "cost_per_contact": 15,
  "cost_per_lead": 10,
  "cost_per_mille": 6,
  "cost_per_purchase": 30,
  "cost_per_result": 40,
  "cost_per_schedule": 22,
  "cost_per_submitted_application": 120,
  "cost_per_unique_click": 0.4,
  "cost_per_viewed_content": 1.1,
  "created_at": "2026-01-01T12:00:00.000Z",
  "custom_conversions": 41,
  "custom_event_counts": {
    "gift_card_purchased": 5,
    "quote_requested": 33
  },
  "custom_event_values": {
    "gift_card_purchased": 750,
    "quote_requested": 0
  },
  "delivery_status": "no_ads",
  "demographics": {
    "gender": "all",
    "maximum_age": 64,
    "minimum_age": 21
  },
  "desired_cost_per_result": 40,
  "detailed_targeting": {
    "behaviors": [
      {
        "behavior_type": "video",
        "id": "6007101291578",
        "name": "Recent vehicle purchase (30 days)"
      }
    ],
    "demographics": [
      {
        "id": "6002714398172",
        "name": "Recently moved",
        "type": "life_events"
      }
    ],
    "interests": [
      {
        "id": "6003193685204",
        "name": "Car wash"
      }
    ]
  },
  "devices": {
    "operating_systems": [
      {
        "minimum_version": "18.0",
        "os": "ios"
      }
    ],
    "platforms": [
      "mobile"
    ]
  },
  "ends_at": "2026-01-01T12:00:00.000Z",
  "frequency_cap": {
    "maximum_impressions": 3,
    "per_days": 7
  },
  "id": "adgrp_xxxxxxxxxxxxxx",
  "impressions": 220000,
  "issues": [
    {
      "id": "adiss_xxxxxxxxxxxxxx",
      "message": "Your ad was rejected for unacceptable business practices. Edit the ad's content and resubmit.",
      "resource_id": "ad_xxxxxxxxxxxxxx",
      "resource_type": "ad"
    }
  ],
  "languages": [
    "en"
  ],
  "lead_value": 3960,
  "leads": 132,
  "link_clicks": 4400,
  "message_apps": [
    "instagram"
  ],
  "minimum_daily_spend": 25,
  "optimization_goal": "conversions",
  "placements": [
    {
      "platform": "facebook",
      "positions": [
        "feed"
      ]
    }
  ],
  "platform": "meta",
  "purchase_value": 7920,
  "purchases": 44,
  "regions": {
    "exclude": {
      "cities": [
        {
          "key": "2418046",
          "name": "Austin"
        }
      ],
      "countries": [
        "US"
      ],
      "country_groups": [
        "north_america"
      ],
      "custom_locations": [
        {
          "distance_unit": "mile",
          "latitude": 30.2672,
          "longitude": -97.7431,
          "name": "4180 Burnet Rd, Austin TX 78756",
          "radius": 25
        }
      ],
      "regions": [
        "US-TX"
      ],
      "zips": [
        "US:78756"
      ]
    },
    "include": {
      "cities": [
        {
          "key": "2418046",
          "name": "Austin"
        }
      ],
      "countries": [
        "US"
      ],
      "country_groups": [
        "north_america"
      ],
      "custom_locations": [
        {
          "distance_unit": "mile",
          "latitude": 30.2672,
          "longitude": -97.7431,
          "name": "4180 Burnet Rd, Austin TX 78756",
          "radius": 25
        }
      ],
      "regions": [
        "US-TX"
      ],
      "zips": [
        "US:78756"
      ]
    }
  },
  "result_event": "custom",
  "result_event_name": "quote_requested",
  "results": 33,
  "return_on_ad_spend": 6,
  "schedule_value": 5400,
  "schedules": 60,
  "spend": 1320,
  "spend_currency": "usd",
  "starts_at": "2026-01-01T12:00:00.000Z",
  "status": "active",
  "submitted_application_value": 1320,
  "submitted_applications": 11,
  "title": "Austin ceramic coating — repeat customers",
  "unique_clicks": 3300,
  "updated_at": "2026-01-01T12:00:00.000Z",
  "viewed_content_value": 8400,
  "viewed_contents": 1200
}

Changes

Changed in 11 of the 74 revisions of this API.123841

Sep 24, 20267fcefabddb0a12See the full diff
- ●
  added the new google enum value to the response property for the response status
  response-property-enum-value-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 23, 2026140d015b99661See the full diff
- ●
  added the new in_appeal enum value to the response property for the response status
  response-property-enum-value-added
Sep 21, 2026ac2b9b1c6a003See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
Aug 27, 202616c82685be352See the full diff
- ○
  the response property became required for the status
  response-property-became-required
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 20, 20266a23760847c88See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
Aug 15, 2026c301132dbfd71See the full diff
- ●
  added the new messaging_conversation enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 12, 2026ae20b30817de4See the full diff
- ●
  added the new education_majors enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new education_schools enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new work_employers enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new work_positions enum value to the /// response property for the response status
  response-property-enum-value-added
Aug 7, 2026f1020c3ecda41See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 2026099fdc3be4226See the full diff
- ●
  added the new audience_network enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new facebook enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new instagram enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new messenger enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new threads enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new whatsapp enum value to the // response property for the response status
  response-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 202660bbb4a6ffbc122523See the full diff
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  added subschema #2 to the response property oneOf list for the response status
  response-property-one-of-added
- ▲
  the response's property type changed from object null to no type for status
  response-property-type-changed
- ●
  added the new ad_recall_lift enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new conversations enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new conversions enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new duplicating enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new engagement enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new event_responses enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new impressions enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new instagram enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new instagram_and_facebook enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new instagram_profile enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new landing_page_views enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new lead_generation enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new link_clicks enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new messenger enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new page_likes enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new profile_and_page_engagement enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new quality_lead enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new reach enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new reminders_set enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new social_profile enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new two_second_views enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new undefined enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new value enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new video_views enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new whatsapp enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new optional query request parameter attribution_model
  new-optional-request-parameter
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.

Full history (11 revisions)