Get Campaign Group Summary Report

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Overview

The Campaign Group Summary Report returns general metrics (impressions, clicks, conversions, spend) and performance metrics (CTR, CPC, CPM, CPA) for one or more campaign groups, broken down by the dimension you select.

Requires the CAMPAIGN_GROUPS_OPERATIONS permission.

Supported dimensions

Dimension	Returned key columns	Mandatory filters	Optional filters
`campaign_group_breakdown`	`campaigns_group_id`, `campaigns_group_name`	`start_date`, `end_date`	`campaigns_group_id`, `campaigns_group_name`, `campaigns_group_status`, `campaign`, `platform`, `country`, `site`, `browser`, `os_family`, `os_version`
`campaign_group_day_breakdown`	`date`, `campaigns_group_id`, `campaigns_group_name`	`start_date`, `end_date`	Same as above

Supported filters

Filter	Format / values	Notes
`start_date` (required)	ISO 8601 date or datetime
`end_date` (required)	ISO 8601 date or datetime
`campaign`	Numeric campaign ID
`platform`	`DESK` (desktop), `PHON` (smartphone), `TBLT` (tablet)
`country`	2-letter ISO 3166 code
`site`	Publisher `site_name`
`browser`	Browser code	See Get list of Browsers.
`os_family`	OS family name	See Get list of Operating Systems.
`os_version`	OS version under the OS family	Always pair with the matching `os_family`. Supported families: Android, iOS, iPadOS, Windows.
`fetch_config`	Boolean	If `true`, also returns the configuration columns for each campaign group.

Dimension columns

These appear only for dimensions that include them. See the table above.

Column	Type	Description
`date`	Date	Exact date (day dimension only).
`content_provider_id`	Long	Machine-readable provider ID.
`content_provider_name`	String	Human-readable content provider name.
`campaigns_group_id`	Long	ID of the campaign group.
`campaigns_group_name`	String	Human-readable name.
`campaigns_group_status`	String	Campaign group status.
`linked_campaigns`	Long	Number of campaigns in the group.

Standard columns

Column	Type	Description
`impressions`	Integer	Total impressions.
`visible_impressions`	Integer	Total viewable impressions.
`clicks`	Integer	Total clicks.
`spent`	Money	Total amount spent.
`conversions_value`	Money	Total revenue from conversions.
`cpa_actions_num`	Integer	Total conversions (actions).
`ctr`	Percent	Clicks divided by impressions.
`vctr`	Percent	Clicks divided by viewable impressions.
`cpc`	Money	Spend divided by clicks.
`cpm`	Money	Cost per 1,000 impressions.
`vcpm`	Money	Cost per 1,000 viewable impressions.
`cpa`	Money	Spend divided by actions.
`roas`	Money	Conversion value divided by ad spend.
`currency`	Currency code (ISO 4217)	Currency for money columns.
`cpa_conversion_rate`	Percent	Actions divided by clicks.

Example - `campaign_group_breakdown` with `fetch_config`

GET /backstage/api/1.0/taboola-demo-advertiser/reports/campaign-group-summary/dimensions/campaign_group_breakdown?start_date=2024-07-01T00:00:00&end_date=2024-07-02T23:59:59&fetch_config=true

{
  "results": [
    {
      "content_provider_name": "Content provider name",
      "content_provider_id": 1234567,
      "campaigns_group_name": "group_1",
      "campaigns_group_id": 12345,
      "campaigns_group_status": "RUNNING",
      "linked_campaigns": 26,
      "budget_limit": 20000.00,
      "start_date": "2024-06-03 04:00:00.0",
      "end_date": "9999-12-31 23:59:59.0",
      "is_active": true,
      "clicks": 16189,
      "impressions": 4115630,
      "visible_impressions": 4115612,
      "spent": 12616.74,
      "conversions_value": 0.00,
      "roas": 0.00,
      "ctr": 0.393,
      "vctr": 0.393,
      "cpm": 3.07,
      "vcpm": 3.07,
      "cpc": 0.779,
      "cpa": 65.37,
      "cpa_actions_num": 193,
      "cpa_conversion_rate": 1.19,
      "currency": "USD"
    },
    ...
  ]
}

Example - `campaign_group_day_breakdown` with `include_totals`

GET /backstage/api/1.0/taboola-demo-advertiser/reports/campaign-group-summary/dimensions/campaign_group_day_breakdown?start_date=2024-07-01T00:00:00&end_date=2024-07-02T23:59:59&include_totals=true

{
  "results": [
    {
      "date": "2024-07-02 00:00:00.0",
      "campaigns_group_id": 12345,
      "campaigns_group_name": "group_1",
      "clicks": 12548,
      "impressions": 1583086,
      "spent": 6713.21,
      "ctr": 0.79,
      "cpc": 0.535,
      "cpa": 82.88,
      "cpa_actions_num": 81,
      "currency": "USD"
    },
    ...
  ],
  "total": {
    "clicks": 39213,
    "impressions": 7249888,
    "spent": 24882.01,
    "cpa_actions_num": 332,
    "currency": "USD"
  }
}