List ad groups
Returns a paginated list of ad groups scoped by campaign or company, with optional filtering by status and creation date.
Required permissions:
ad_campaign:basic:read
Authorizations
A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Query Parameters
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
42
Returns the last n elements from the list.
42
Only return ad groups belonging to these ad campaigns (max 100). Can be combined with companyId or used on its own.
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
Filter by company. Provide companyId or adCampaignIds.
"biz_xxxxxxxxxxxxxx"
Only return ad groups created after this timestamp.
"2023-12-01T05:00:00.401Z"
Only return ad groups created before this timestamp.
"2023-12-01T05:00:00.401Z"
Case-insensitive substring match against the ad group name or ID.
Inclusive start of the window for each ad group's metric fields (spend, impressions, …). Omit both statsFrom and statsTo for all-time stats.
"2023-12-01T05:00:00.401Z"
Inclusive end of the window for each ad group's metric fields. Omit both statsFrom and statsTo for all-time stats.
"2023-12-01T05:00:00.401Z"
Filter ad groups by their current status.
active, paused, inactive, in_review, rejected, flagged The field to order results by. Stat columns (spend, impressions, …) sort over the statsFrom/statsTo window and rank across all ad groups, not just the current page. Defaults to creation date.
created_at, spend, impressions, clicks, reach, unique_clicks, results, click_through_rate, cost_per_click, cost_per_mille, cost_per_result, frequency, return_on_ad_spend The sort direction for results. Defaults to descending.
asc, desc Filter by campaign.
Filter by ad campaign. Provide exactly one of ad_campaign_id or company_id.

