Skip to main content

GET Account Transactions Breakdown

Returns performance metrics for a Rokt Ecommerce partner account broken down by an attribute for a given time period, time zone, and currency.

Description#

Call this API endpoint to receive account-level transaction metrics 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:

  • age;
  • brand;
  • gender;
  • page;
  • pagetype;
  • placement;
  • position.

Note: The placement breakdown does not return results for page-level metrics including transactions, purchases, or RPT.

Request#

Path

GET /reporting/accounts/{accountId}/transactions/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 

Response#

200 OK

{  "groupByValue": "string",  "revenue": 0,  "transactions": 0,  "placementImpressions": 0,  "impressions": 0,  "referrals": 0,  "purchases": 0,  "positivePlacementEngagements": 0,  "rpt": 0,  "rpm": 0}
Was this article helpful?