Skip to main content
GET
Get ad analytics overview

Authorizations

Authorization
string
header
required

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

Query Parameters

from
string
required

Start date (YYYY-MM-DD, inclusive).

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string
required

End date (YYYY-MM-DD, inclusive).

Pattern: ^\d{4}-\d{2}-\d{2}$
tz
string

IANA timezone used to bucket results.

adAccountId
string

Restrict to this Meta ad account id (act_). Get it from ads.listChannelAdAccounts.

Pattern: ^act_\d+$
channel
enum<string>

Restrict to this channel.

Available options:
whatsapp,
messenger,
instagram
integrationWhatsappId
string

Restrict to this WhatsApp integration.

Pattern: ^\d+$
integrationMessengerId
string

Restrict to this Messenger integration.

Pattern: ^\d+$
integrationInstagramId
string

Restrict to this Instagram integration.

Pattern: ^\d+$
allChannels
boolean

Aggregate across every channel instead of one. Mutually exclusive with channel/integration filters.

Response

OK

totals
object
required
perAd
object[]
required
spendCurrency
string | null
required