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/breakdownParameters
| 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 |
Response#
200 OK
{ "groupByValue": "string", "revenue": 0, "transactions": 0, "placementImpressions": 0, "impressions": 0, "referrals": 0, "purchases": 0, "positivePlacementEngagements": 0, "rpt": 0, "rpm": 0}