Edit

GET Campaign Histogram

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

Description

Call this API endpoint to receive histogram of a campaign's performance metrics, like impressions, referrals, conversions over a time period.

Request

Path

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

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

]

}