report/export

GET/report/export

Fetch CSV-schema export rows for the requested time range. Requires the reports:read permission.

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/report/export?start_time=1712448000&end_time=1712534399" \
  -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.
`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.

Responses

CSV-schema export rows.

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

200 CSV-schema export rows.

Field	Type	Description
`columns`required	`array of string`
`rows`required	`array of array of string`
`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`