Campaign Summary Report

Returns performance metrics for your campaigns.

Usage:

  1. Provide a dimension (as a path param).
  2. Provide relevant filters (as query params).

Guidelines:

  1. Your chosen dimension determines which filters you can use. See the topics that follow.
  2. platform, country, site and partner_name are mutually exclusive filters - you can apply 1 only.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

An alphabetic ID. See Get Account Details.

string
required

The report dimension (aka view) e.g. day, week, month, etc.
For a list of possible values, see: Dimensions Cheat Sheet

Query Params
string
required
Defaults to 2021-01-01

yyyy-mm-dd
Required for all dimensions.
Hourly reporting supports timestamps - see: Dimensions Cheat Sheet

string
required
Defaults to 2021-01-02

yyyy-mm-dd
Required for all dimensions.
Hourly reporting supports timestamps - see: Dimensions Cheat Sheet

string

The campaign_id (A numeric string).
Supported dimension: by_campaign

string

Possible values:
DESK
PHON
TBLT
Unsupported dimensions:
site_breakdown, country_breakdown, region_breakdown, dma_breakdown, platform_breakdown

string

2-letter country code, as defined by ISO-3166 (not case-sensitive).
Use the Dictionary to fetch a list of allowed values.
Unsupported dimensions:
site_breakdown, country_breakdown, region_breakdown, dma_breakdown, platform_breakdown

string

The site_name of a specific publisher.
Unsupported dimensions:
site_breakdown, country_breakdown, region_breakdown, dma_breakdown, platform_breakdown, user_segment_breakdown

string

Name of the data partner.
Supported by a single dimension: user_segment_breakdown.

boolean

If set to true, the report will include Custom Conversion Columns.
Unsupported dimensions: by_hour_of_day.

Language
LoadingLoading…