Campaign Summary Report

get

https://backstage.taboola.com/backstage/api/1.0/{account_id}/reports/campaign-summary/dimensions/{dimension}

Returns performance metrics for your campaigns.

Usage:

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

Guidelines:

Your chosen dimension determines which filters you can use. See the topics that follow.
platform, country, site and partner_name are mutually exclusive filters - you can apply 1 only.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

An alphabetic ID. See Get Account Details.

dimension

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

start_date

string

required

Defaults to 2021-01-01

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

end_date

string

required

Defaults to 2021-01-02

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

campaign

string

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

platform

string

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

country

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

site

string

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

partner_name

string

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

include_multi_conversions

boolean

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