Skip to main content

Breakdown

Overview​

The breakdown parameter allows you to create sub-breakdowns of your data by additional dimensions. It enables you to drill down into specific segments of your main query results.

Parameters​

ParameterDescriptionValuesRequired
columnsThe columns you want to spread on with the breakdownArray of property/metric namesYes
page-numPage number for pagination of breakdown resultsInteger (default: 1)No
max-resultsMaximum number of results per breakdownIntegerNo
note

Other parameters are forbidden in the breakdown object and will throw an error if present.

Examples​

Example 1: Single breakdown column​

Breaking down countries by their cities.

{
"columns": ["geo_country", "m_events", "m_visits"],
"breakdown": {
"columns": ["geo_city"],
"page-num": 1,
"max-results": 5
}
}

Example 2: Multiple breakdown columns​

Breaking down countries by metro region and then by city.

{
"columns": ["geo_country", "m_events", "m_visits"],
"breakdown": {
"columns": ["geo_metro", "geo_city"],
"page-num": 1,
"max-results": 5
}
}