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/overviewParameters
| Name | Type | In | Description | Required | Example |
|---|---|---|---|---|---|
dateStart | String | query | Start time of the requested date/time range | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | End time of the requested date/time range | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Currency code in which you will receive monetary metrics. | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Desired timezone can be passed through this parameter. It has to be in Olson format. | true | timeZoneVariation=Australia/Sydney |
groupBy | Enum: country partner-source campaign audience creative | query | The criterion based on which the results will be broken down. By default it's 'campaign'. | true | partner-source |
accountId | String | path | 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}