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

List Ad Groups

Lists ad groups for the account, newest first.

get/ad_groups

Query parameters

account_idstring

Account whose ad groups to list. Defaults to the authenticated account.

ad_campaign_idstring

Filter to ad groups in this campaign.

ad_campaign_idsstring[]

Filter to ad groups in these campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b).

[
  "adcamp_xxxxxxxxxxxxxx"
]

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

Filter to ad groups with this status.

querystring

Filter ad groups by a title or ID substring.

The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports.

direction'asc' | 'desc'

The sort direction. Defaults to desc.

created_beforestring

Only return ad groups created before this timestamp.

created_afterstring

Only return ad groups created after this timestamp.

stats_fromstring

Start of the stats window. Defaults to all-time.

stats_tostring

End of the stats window. Defaults to now.

time_zonestring

IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare stats_from/stats_to dates resolve to day boundaries on this clock. 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.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

ad groups listed

Example response

{
  "data": [
    {
      "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
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 10 of the 74 revisions of this API.133846

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, 202616c82685be353See the full diff
- ○
  added the new enum value link_clicks to the query request parameter order
  request-parameter-enum-value-added
- ○
  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
Jul 31, 2026099fdc3be42261See 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
- ○
  added the new optional query request parameter ad_campaign_ids
  new-optional-request-parameter
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 202660bbb4a6ffbc132527See the full diff
- ▲
  the query request parameter status was restricted to a list of enum values
  request-parameter-became-enum
- ▲
  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 new enum value active to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value duplicating to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value paused to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value rejected to the query request parameter status
  request-parameter-enum-value-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
- ○
  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
Jul 14, 20263a06a605784b2See the full diff
- ○
  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

Of the 74 revisions, 1 has no diff computed.

Full history