API explorer
Getting Started

Sections

Theme switcher

Advertiser Metrics - Aggregated

Header Parameters

api-keystring

Query Parameters

domainstring Required

Enter website of interest, without 'www.' or brackets {}

granularitystring

Time granularity for the returned values

Enum values:
monthlydaily
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

channelsarray Required

Comma-separated list of ad channels, one result row per channel: display. Required

Enum values:
display
metricsarray

Comma-separated list of metrics: spend, impressions, active_ads_count, active_campaigns_count

Enum values:
spendimpressionsactive_ads_countactive_campaigns_count
currencystring

Currency for monetary values: usd (default), eur, gbp, jpy, aud, ars, brl, clp, cop, mxn, pen or uyu

Enum values:
audeurgbpjpyusdarsbrlclpcopmxn
... 2 other enums
formatstring

Format in which the reply should be returned

Enum values:
jsonxml

Response

200
Object

OK

Response Attributes

metaobject Required

Show child attributes

dataarray | null Required

Show child attributes

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?