Breakdown
Note: Each breakdown will return a JSON object which includes both an entity name and id.
Breakdown Parameter
REQUIRED.
Parameter | Type | Examples |
| array of strings |
|
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 | Breakdown options for Preferred campaigns |
GET | Breakdown options for Marketplace campaigns |
GET | Breakdown options for Managed campaigns |
GET | Breakdown options for Demand |
GET | Breakdown options for Auction |
GET | 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 |
| Removed |
Breakdown Dependencies
π§
Requests must include dependencies
Some breakdowns must be used together in the same request.
Label | Value | Required Breakdown |
Publication URL |
|
|
Breakdown Compatibility
π§
Some combinations are invalid
Some metrics are not compatible with certain breakdown or filters.
Label | Value | Incompatible Breakdown/Filter |
Ad Content |
|
|
Ad Headline |
|
|
Ad Preview Image |
|
|
Conversion Tag |
|
|
Country |
|
|
Device |
|
|
Device Type |
|
|
DMA |
|
|
Placement |
|
|
Placement Location |
|
|
Publication Section |
|
|
Section Type |
|
|
State/Region |
|
|
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" } ] }