Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
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.

order'created_at' | 'updated_at' | 'spend' | 'impressions' | 'reach' | 'clicks' | 'unique_clicks' | 'frequency' | 'click_through_rate' | 'results' | 'cost_per_mille' | 'cost_per_click' | 'cost_per_result' | 'return_on_ad_spend'

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

The number of ad groups to return.

afterstring

Cursor to fetch the page after (from page_info.end_cursor).

lastinteger

The number of ad groups to return from the end of the range.

beforestring

Cursor to fetch the page before (from page_info.start_cursor).

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_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": [
          {
            "id": "6003193685204",
            "name": "Car wash"
          }
        ],
        "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,
      "message_apps": [
        "instagram"
      ],
      "minimum_daily_spend": 25,
      "optimization_goal": "conversions",
      "placements": [
        {
          "platform": "facebook",
          "positions": [
            "feed"
          ]
        }
      ],
      "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": [
            "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": [
            "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": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}