Skip to main content

GET Account Summary

Returns performance metrics for an account's total activity for a given time period, time zone, and currency. This API endpoint may be used for both Rokt Ecommerce partner account data and Rokt Ads advertiser account data.

Description#

Call this API endpoint to receive account-level performance metrics for a specified time period, time zone, and currency.

Request#

Path

GET /reporting/accounts/{accountId}/summary

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

{  "campaignsSummary": {  "grossCost": 0,  "netCost": 0,  "impressions": 0,  "uniqueSessions": 0,  "referrals": 0,  "acquisitionsByConversionDate": 0,  "acquisitionsByReferralDate": 0,  "campaigns": 0,  "creatives": 0,  "audiences": 0,  "campaignCountries": 0  },  "transactionsSummary": {  "revenue": 0,  "transactions": 0,  "placementImpressions": 0,  "impressions": 0,  "referrals": 0,  "rpt": 0,  "rpm": 0,  "positivePlacementEngagements": 0,  "purchases": 0  }}
Was this article helpful?