Skip to main content
GET
Get Account Insights

Authorizations

X-API-Key
string
header
required

Query Parameters

organization_id
string<uuid> | null

Organization scope for API keys that can access multiple organizations.

aggregation_level
enum<string> | null

Row entity for the insights breakdown. campaign returns one row per campaign.

Available options:
ad_account,
campaign,
ad_group,
ad
time_granularity
enum<string> | null

Time bucket for the rows; none or omitted returns totals over the whole range.

Available options:
hourly,
daily,
monthly,
none
time_ranges[]
string[] | null

Time ranges as JSON objects, e.g. {"type": "date_range", "since": "2026-07-01", "until": "2026-07-18"}.

limit
integer | null

Maximum rows to return.

Required range: 1 <= x <= 2000
after
string | null

Return items after this ID (forward pagination).

before
string | null

Return items before this ID (backward pagination).

Response

Successful Response

Cursor-paginated insights, mirroring the OpenAI Ads insights envelope.

data
InsightRow · object[]
required

Insight rows.

count
integer | null

Total row count, when reported upstream.

first_id
string | null

ID of the first item; pass as before to page back.

last_id
string | null

ID of the last item; pass as after to page forward.

has_more
boolean
default:false

Whether more items are available.