Skip to main content
GET
Get Whats Working Report Route

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
string<uuid>
required

Query Parameters

date_preset
string
default:last_14d
since
string<date> | null
until
string<date> | null
sort_metric
enum<string>
default:spend
Available options:
spend,
roas,
cpa,
purchase_value,
ctr,
cpm,
purchases,
impressions

Response

Successful Response

brand_id
string<uuid>
required
status
enum<string>
required
Available options:
ok,
not_connected,
needs_account_selection
date_preset
string
required
generated_at
string<date-time>
required
account_id
string | null
account_name
string | null
currency
string | null
account_timezone_name
string | null
date_start
string<date> | null
date_end
string<date> | null
rows
WhatsWorkingRow · object[]
totals
WhatsWorkingMetrics · object | null

Aggregated Meta insights metrics for one ad group (or the report totals).

Raw counters are summed across the group's ads; ratio metrics are derived AFTER aggregation (never averaged) and are None when the denominator is zero.