Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 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).

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": [
    {
      "bid_type": "minimum_cost",
      "budget_type": "daily",
      "conversion_location": "website",
      "delivery_status": "all_ads_rejected",
      "demographics": {
        "gender": "all"
      },
      "detailed_targeting": {
        "demographics": [
          {
            "type": "life_events"
          }
        ]
      },
      "devices": {
        "operating_systems": [
          {
            "os": "ios"
          }
        ],
        "platforms": [
          "mobile"
        ]
      },
      "issues": [
        {
          "resource_type": "ad_campaign"
        }
      ],
      "message_apps": [
        "messenger"
      ],
      "optimization_goal": "conversions",
      "placements": [
        {
          "platform": "facebook"
        }
      ],
      "regions": {
        "exclude": {
          "custom_locations": [
            {
              "distance_unit": "mile"
            }
          ]
        },
        "include": {
          "custom_locations": [
            {
              "distance_unit": "mile"
            }
          ]
        }
      },
      "result_event": "purchase",
      "status": "active"
    }
  ]
}