Edit

GET Campaign Breakdown

Returns performance metrics for a campaign broken down by an attribute for a given time period, time zone and currency.

Description

Call this API endpoint to receive campaign level broken by an attribute specified in the query string performance metrics, like impressions, referrals, conversions for a specified time period, timezone and currency.

Request

Path

GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown

Parameters

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
accountId	String	path		true
campaignId	String	path		true

Response

200 OK

Example Value

Schema

{
  "items": [
    "string"
  ]
}

Object {

items: Array [

String

]

}