Skip to main content

GET Account Campaigns Overview

Returns performance metrics for an account's total activity for a given time period, time zone, and currency. The result is broken down by campaign by default, but can also be broken due by country or partner source.

Description#

Call this API endpoint to receive account-level performance metrics, like impressions, referrals, conversions, broken down by camapignid for a specified time period, time zone, and currency.

Request#

Path

GET /reporting/accounts/{accountId}/campaigns/overview

Parameters

NameTypeInDescriptionRequiredExample
dateStartStringqueryStart time of the requested date/time rangetruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryEnd time of the requested date/time rangetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY
queryCurrency code in which you will receive monetary metrics.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney
queryDesired timezone can be passed through this parameter. It has to be in Olson format.truetimeZoneVariation=Australia/Sydney
groupByEnum:
country
partner-source
campaign
audience
creative
queryThe criterion based on which the results will be broken down. By default it's 'campaign'.truepartner-source
accountIdStringpath true 

Response#

200 OK

{"acquisitionsByConversionDate": 0,"acquisitionsByReferralDate": 0,"audiences": 0,"campaignCountries": 0,"campaignId": "string","campaignName": "string","campaigns": 0,"creatives": 0,"grossCost": 0,"impressions": 0,"netCost": 0,"referrals": 0,"uniqueSessions": 0}
Was this article helpful?