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

›Campaign 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
  • Nurture Unsubscribe
  • Attributes

Reporting

  • Overview
  • Authentication
  • Account Level

    • GET Account Summary
    • GET Account Campaigns Overview
    • GET Account Campaigns Breakdown
    • 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
  • Authentication
  • Subscription

    • DELETE Subscription Event
    • DELETE Deactivate Subscriptions
    • GET Subscription Details

    Subscription Event

    • DELETE Delete Subscription Event
    • POST Create New Subscription Event
    • POST Update Subscription Event

    Calendar

    • GET Calendar Events

    Schedule

    • GET Subscription Schedule

    Subscribe

    • POST Create New Subscription
Edit

GET Campaign Breakdown

Returns performance metrics for a campaign broken down by an attribute for a given time period, time zone and currency.

Description

Call this API endpoint to receive campaign level broken by an attribute specified in the query string performance metrics, like impressions, referrals, conversions for a specified time period, timezone and currency.

Request

Path

GET /reporting/accounts/{accountId}/campaigns/{campaignId}/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 
campaignIdStringpath true 

Response

200 OK

Example Value
Schema
{
"items": [
"string"
]
}
Object {
items: Array [
String
]
}
← GET Campaign OverviewGET Campaign Histogram →
  • Description
  • Request
  • Response
RESOURCES
DocumentationUser GuideSDKAPIIntegration PartnersHelp
COMPANY
About UsContact UsCareersEngineering Blog
Rokt Documentation
Copyright © Rokt 2021 - All Rights Reserved