Sign in

v1

latestOpenAPI 3.0.32026-07-261910783.9 KB
Reporting

report/breakdown

Fetch grouped reporting rows for the requested time range. Requires the reports:read permission.

get/report/breakdown

Query parameters

start_timeinteger required

Start of the time range as a Unix timestamp in seconds. The requested range must not exceed 31 days.

end_timeinteger required

End of the time range as a Unix timestamp in seconds. The requested range must not exceed 31 days.

bystring required

Comma-separated breakdown dimensions. Supported values are hour, day, week, month, country, os, app, ad_unit, and format.

metricsstring required

Comma-separated metric names to include in each breakdown row.

test_mode'production' | 'test' | 'all'

Traffic mode to include. Defaults to production traffic.

countrystring

ISO 3166-1 alpha-2 country code filter.

device_os'iOS' | 'Android'

Device operating system filter.

granularity'daily' | 'hourly'

Reporting bucket size. Defaults to daily.

topinteger

Return the top N rows sorted by the first requested metric.

bottominteger

Return the bottom N rows sorted by the first requested metric.

havingstring

Metric filter expression, such as revenue > 10.

Response

CloudX breakdown data.

dimensionsstring[] required
metricsstring[] required
row_countinteger required