Dimensions, Filters and Columns

Dimensions

When you invoke the reporting endpoint for a given report, you need to specify the desired dimension. A dimension determines how data is aggregated. For example, you might choose the platform_breakdown dimension, to see data aggregated per-platform - or the day dimension, to see data aggregated per-day.

The following code snippet shows a call made to the Campaign Summary Report with the day dimension. (The dimension path param follows just after "/dimensions/".)

GET /backstage/api/1.0/taboola-demo-advertiser/reports/
campaign-summary/dimensions/day?start_date=2015-03-30&end_date=2015-03-30

Filters

For a given report and dimension, you will need to pass 1 or more appropriate filters. Filters are query string params that filter the data view returned (i.e. reduce the size of the result set).

For a given dimension, there are mandatory filters (that must be passed in every request) - as well as optional filters (that you can add at your own discretion).

In the following code snippet, 2 mandatory filters are passed in the query string - start_date and end_date:

GET /backstage/api/1.0/taboola-demo-advertiser/reports/
campaign-summary/dimensions/day?start_date=2015-03-30&end_date=2015-03-30

📘

For each dimension supported by a given report, refer to the documentation for a list of mandatory and optional filters:

Columns

Standard Columns

Certain columns store typical reporting values, and are present for most or all dimensions. These are referred to as standard columns.

Dimension-specific Columns

Certain report columns are are dimension-specific - i.e. they apply to specific dimensions only.

📘

For each report, refer to the documentation for a list of standard columns and dimension-specific columns.