Rokt Documentation
  • Documentation
  • User Guide
  • SDK
  • API
  • Third-Party Integrations
  • Help

›Account Level

Getting Started

  • Introduction

Transactions

    Events

    • Overview
    • Authentication
    • POST Events

    Cart

    • Overview
    • POST Reserve Cart Items
    • POST Confirm Cart Items
    • POST Release Cart Items

    Confirmation

    • POST Cancel Confirmed Item

    Placements

    • POST Any Placements

Customer Data

  • Referral Export
  • Transaction Export
  • Custom Audience Import
  • Unsubscribe Import
  • Attributes

Reporting

  • Overview
  • Authentication
  • Account Level

    • GET Account Summary
    • GET Account Campaigns Overview
    • GET Account Campaigns Breakdown
    • GET Account Campaigns Histogram
    • GET Account Transactions Overview
    • GET Account Transactions Breakdown

    Campaign Level

    • GET Campaign Overview
    • GET Campaign Breakdown
    • GET Campaign Histogram

    Creative Level

    • GET Creative Overview
    • GET Creative Breakdown

    Metadata

    • GET Campaign Metadata
    • GET Audience Metadata
    • GET Creative Metadata
    • GET Accounts Metadata

Rokt Calendar

  • Overview
Edit

GET Account Summary

Returns performance metrics for an account's total activity for a given time period, time zone and currency.

Description

Call this API endpoint to receive account level performance metrics for a specified time period, timezone 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

Example Value
Schema
{
"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
}
}
Object {
campaignsSummary: AllOf Object {
grossCost: Number
netCost: Number
impressions: Number
uniqueSessions: Number
referrals: Number
acquisitionsByConversionDate: Number
acquisitionsByReferralDate: Number
campaigns: Number
creatives: Number
audiences: Number
campaignCountries: Number
}
transactionsSummary: AllOf Object {
revenue: Number
transactions: Number
placementImpressions: Number
impressions: Number
referrals: Number
rpt: Number
rpm: Number
positivePlacementEngagements: Number
purchases: Number
}
}
← AuthenticationGET Account Campaigns Overview →
  • Description
  • Request
  • Response
RESOURCES
DocumentationUser GuideSDKAPIIntegration PartnersHelp
COMPANY
About UsContact UsCareersEngineering Blog
Rokt Documentation
Copyright © Rokt 2021 - All Rights Reserved