Skip to main content

GET Account Campaigns Breakdown

Returns performance metrics for a Rokt Ads advertiser account's total activity for a given time period, time zone, and currency. By default, the result is broken down by campaign, but you may also break out activity by country or partner source.

Description#

Call this API endpoint to receive account-level data broken down by camapignid for a specified time period, time zone, and currency. The attributes that may be called through the "groupby" parameter include:

  • country;
  • partner-source.

Request#

Path

GET /reporting/accounts/{accountId}/campaigns/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 metricstruecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney
queryDesired time zone can in Olson formattruetimeZoneVariation=Australia/Sydney
accountIdStringpathYour Rokt Account ID. Found in One Platform or provided by your account manager. true 

Response#

200 OK

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