report/breakdown

GET/report/breakdown

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

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/report/breakdown?start_time=1712448000&end_time=1712534399&by=day,app&metrics=requests,impressions,revenue" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Query parameters

Name	Type	Description
`start_time`required	`integer<int64>`	Start of the time range as a Unix timestamp in seconds. The requested range must not exceed 31 days and must not start before 2020-01-01 UTC.
`end_time`required	`integer<int64>`	End of the time range as a Unix timestamp in seconds. The requested range must not exceed 31 days and must not end before 2020-01-01 UTC.
`by`required	`string`	Comma-separated breakdown dimensions. Supported values are `hour`, `day`, `week`, `month`, `country`, `os`, `app`, `ad_unit`, and `format`.
`metrics`required	`string`	Comma-separated metric names to include in each breakdown row.
`test_mode`	`string`	Traffic mode to include. Defaults to production traffic.
`country`	`string`	ISO 3166-1 alpha-2 country code filter.
`device_os`	`string`	Device operating system filter.
`granularity`	`string`	Reporting bucket size. Defaults to daily.
`top`	`integer<int32>`	Return the top N rows sorted by the first requested metric.
`bottom`	`integer<int32>`	Return the bottom N rows sorted by the first requested metric.
`having`	`string`	Metric filter expression, such as `revenue > 10`.

Responses

CloudX breakdown data.

{
  "dimensions": [
    "<string>"
  ],
  "metrics": [
    "<string>"
  ],
  "rows": [
    {
      "dimensions": {},
      "metrics": {}
    }
  ],
  "row_count": 123
}

200 CloudX breakdown data.

Field	Type	Description
`dimensions`required	`array of string`
`metrics`required	`array of string`
`rows`required	`array of object`
`row_count`required	`integer<int64>`

400 Invalid request parameters.

Field	Type	Description
`error`required	`string`

401 Unauthorized.

Field	Type	Description
`error`required	`string`

403 Forbidden.

Field	Type	Description
`error`required	`string`

500 Internal server error.

Field	Type	Description
`error`required	`string`