Skip to main content

Breakdown

M
Written by Megan Pratt
Updated over a month ago

Breakdown

Note: Each breakdown will return a JSON object which includes both an entity name and id.

Breakdown Parameter

REQUIRED.

Parameter

Type

Examples

breakdown

array of strings

"breakdown": ["country", "device_type"]

Available Breakdown Options

The available options for breakdown varies for each specific Reporting resource.

πŸ“˜

New breakdowns

The available breakdowns can change as new features are added.

To get the latest list of available breakdown options for a specific endpoint, submit one of the following requests:

Endpoint

Description

GET /data/direct/options/breakdown

Breakdown options for Direct campaigns

GET
/data/preferred/options/breakdown

Breakdown options for Preferred campaigns

GET
/data/marketplace/options/breakdown

Breakdown options for Marketplace campaigns

GET
/data/managed/options/breakdown

Breakdown options for Managed campaigns

GET
/data/demand/options/breakdown

Breakdown options for Demand

GET
/data/auction/options/breakdown

Breakdown options for Auction

GET
/data/inventory/options/breakdown

Breakdown options for Inventory

Sample Response

The response returns an array of objects where:

  • label: the human-readable name

  • value: the option that can be submitted in a request

Sample Response

{ "data": { "breakdown": [ { "label": "Advertiser", "value": "advertiser" }, { "label": "Campaign", "value": "campaign" } ] }, "messages": null, "status": "success", "status_code": 200 }

Globally Deprecated Breakdowns

The following breakdowns are no longer available for any Reporting resource:

Value

Description

ad_variation

Removed

Breakdown Dependencies

🚧

Requests must include dependencies

Some breakdowns must be used together in the same request.

Label

Value

Required Breakdown

Publication URL

publication_url

publication

Breakdown Compatibility

🚧

Some combinations are invalid

Some metrics are not compatible with certain breakdown or filters.

Label

Value

Incompatible Breakdown/Filter

Ad Content

ad_content

country dma region

Ad Headline

ad_headline

country dma region

Ad Preview Image

ad_preview_image

country dma region

Conversion Tag

conversion_tag

ad_content ad_headline ad_preview_image device device_type placement placement_location

Country

country

ad_content ad_headline ad_preview_image device device_type placement placement_location

Device

device

country dma region

Device Type

device_type

country dma region

DMA

dma

ad_content ad_headline ad_preview_image device device_type placement placement_location

Placement

placement

country dma region

Placement Location

placement_location

country dma region

Publication Section

publication_section

country dma region

Section Type

section_type

country region dma

State/Region

region

ad_content ad_headline ad_preview_image device device_type placement placement_location

If unsupported combinations are used together, you will receive the following response:

Error Message

{ "status": "failed", "status_code": 400, "messages": [ { "text": "Request contains unsupported combination of dimensions: [...]", "level": "error" } ] }
Did this answer your question?