Top Campaign Content Report

Lists the top 1,000 items - for all campaigns, or a specified campaign.

Supports a single dimension: item_breakdown

Rate limit: Tier 3
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Dimensions

The Top Campaign Content Report supports a single dimension: item_breakdown

🚧

Data retention

Reporting data is retained for a period of 3 years.

Sample query with successful response

GET {url}/backstage/api/1.0/demo-account/reports/top-campaign-content/dimensions/item_breakdown?start_date=2019-12-01&end_date=2019-12-31
{
   "last-used-rawdata-update-time": "2019-12-23 02:00:00.0",
   "last-used-rawdata-update-time-gmt-millisec": 1577084400000,
   "timezone": "EST",
   "results": [
      {
         "item": "12345678",
         "item_name": "Sample Campaign Item 1",
         "thumbnail_url": "http://cdn.demo-account.com/thumbnails/thumb-1.jpg",
         "url": "http://www.demo-account.com/wedding-rings",
         "campaign": "2345",
         "campaign_name": "Sample Campaign 1",
         "learning_display_status": "Learning CTR",
         "content_provider": "123456",
         "content_provider_name": "Content Provider 1",
         "impressions": 61609,
         "visible_impressions": 9148,
         "clicks": 40,
         "actions": 40,
         "actions_num_from_clicks": 40,
         "actions_num_from_views": 0,
         "spent": 7.95,
         "conversions_value": 0,
         "roas": 0,
         "ctr": 0.06,
         "vctr": 0.44,
         "cpc": 0.199,
         "cvr": 100,
         "cvr_clicks": 100,
         "cvr_views": 0,
         "cpa": 0.2,
         "cpa_clicks": 0.2,
         "cpa_views": 0,
         "cpm": 0.13,
         "vcpm": 0.87,
         "currency": "USD"
      }
      // additional rows (objects) omitted below...
   ],
   "recordCount": 23,
   "metadata": {
      "total": 23,
      "count": 23,
      "static_fields": [
         {
            "id": "item",
            "format": null,
            "data_type": "STRING"
         },
         {
            "id": "item_name",
            "format": null,
            "data_type": "STRING"
         },
         {
            "id": "thumbnail_url",
            "format": null,
            "data_type": "STRING"
         },
         {
            "id": "url",
            "format": null,
            "data_type": "STRING"
         },
         {
            "id": "campaign",
            "format": null,
            "data_type": "STRING"
         }
         // additional field definitions (objects) omitted below...
      ]
   }
}
📘

Response Body

The response body is a valid, JSON object, with a results property containing the report.

Sample error responses

{
   "http_status": 400,
   "message": "Filter 'campaign' has invalid value",
   "offending_field": "campaign"
}
{
    "http_status": 400,
    "message": "No dimension with Id [imaginary_breakdown] under report Id [campaign-summary] was found"
}

Rate limit

🚧

Rate limit

Tier 3. This report has its own budget, separate from every other report.

See Rate limits for the request allowance each tier carries.

Path Params
string
required

An alphabetic ID. See Get Account Details.

string
required
Defaults to item_breakdown

Supports a single dimension: item_breakdown.

Query Params
string
required
Defaults to 2021-01-01

yyyy-mm-dd

string
required
Defaults to 2021-01-02

yyyy-mm-dd

string

The campaign_id (A numeric string)
Optional filter.

boolean

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

Language
Credentials
OAuth2
LoadingLoading…