Skip to main content
POST
ads.insights.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
level
enum<string>
required

Whether id is a campaign or an ad.

Available options:
campaign,
ad
id
string
required

campaignId from ads.campaigns.list, or adId from ads.ads.list.

Required string length: 1 - 256
fromDate
string

First day of the window, YYYY-MM-DD, inclusive. Defaults to 90 days back.

toDate
string

Last day of the window, YYYY-MM-DD, inclusive. At most 730 days after fromDate.

Response

The result

level
enum<string>
required

The level that was asked for.

Available options:
campaign,
ad
daily
object[]
required

One entry per day with data.

platform
string

Lowercase platform name, as in social.accounts.list.

currency
string

ISO 4217 code of every spend amount below.

partial
boolean

True while older history is still loading: totals cover only part of the range.

summary
object

Totals over the whole range.