Skip to main content

GET Creative Breakdown

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

Description#

Call this API endpoint for details about a specific creative broken down by an attribute specified in the query string for a specified time period, time zone, and currency. The attributes that may be called through the "groupby" parameter include:

  • audience;
  • partner-source.

Request#

Path

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

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
accountIdStringpath true 
campaignIdStringpath true 
creativeIdStringpath true 

Response#

200 OK

{  "groupByValue": "string",  "grossCost": 0,  "netCost": 0,  "impressions": 0,  "uniqueSessions": 0,  "uniqueReferrals": 0,  "referrals": 0,  "acquisitionsByConversionDate": 0,  "acquisitionsByReferralDate": 0,  "creatives": 0,  "audiences": 0}
Was this article helpful?