Skip to main content
GET
/
report
/
breakdown
report/breakdown
curl --request GET \
  --url https://provisioning.cloudx.io/api/v1/report/breakdown \
  --header 'Authorization: Bearer <token>'
{
  "dimensions": [
    "<string>"
  ],
  "metrics": [
    "<string>"
  ],
  "rows": [
    {
      "dimensions": {},
      "metrics": {}
    }
  ],
  "row_count": 123
}

Authorizations

​
Authorization
string
header
default:YOUR_CLOUDX_API_KEY
required

Create or manage API keys in CloudX Settings.

Query Parameters

​
start_time
integer<int64>
required

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

​
end_time
integer<int64>
required

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

​
by
string
required

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

​
metrics
string
required

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

​
test_mode
enum<string>
default:production

Traffic mode to include. Defaults to production traffic.

Available options:
production,
test,
all
​
country
string

ISO 3166-1 alpha-2 country code filter.

​
device_os
enum<string>

Device operating system filter.

Available options:
iOS,
Android
​
granularity
enum<string>
default:daily

Reporting bucket size. Defaults to daily.

Available options:
daily,
hourly
​
top
integer<int32>

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

Required range: 1 <= x <= 1000
​
bottom
integer<int32>

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

Required range: 1 <= x <= 1000
​
having
string

Metric filter expression, such as revenue > 10.

Response

CloudX breakdown data.

​
dimensions
string[]
required
​
metrics
string[]
required
​
rows
object[]
required
Maximum array length: 100000
​
row_count
integer<int64>
required