report/dashboard

GET/report/dashboard

Fetch dashboard summary and chart data for the requested time range. Requires the reports:read permission.

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/report/dashboard?start_time=1712448000&end_time=1712534399" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Query parameters

Name	Type	Description
`timezone`	`string`	IANA timezone for calendar buckets. Defaults to UTC. start_time and end_time remain absolute Unix timestamps and are never shifted. SDK reports, hourly dashboard/breakdown reports, and breakdowns grouped by bidder require whole-hour timezone offsets throughout the requested window because of hourly data and bucketing limitations. A/B reports support UTC only because they use saved UTC-day totals.
`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.
`test_mode`	`string`	Traffic mode to include. Defaults to production traffic. Allowed values: production, test, all.
`country`	`string`	ISO 3166-1 alpha-2 country code filter.
`device_os`	`string`	Device operating system filter. Allowed values: iOS, Android.
`source`	`string`	Reporting source filter. Omit it or use `cloudx` for CloudX-only data. Mediation sources use provisional ILRD, which can undercount without SDK coverage and is not finalized Total Publisher Revenue. Label revenue as CloudX-only or provisional ILRD. Accepts one source, a comma-separated list, or `all`.
`granularity`	`string`	Reporting bucket size. Defaults to daily. Allowed values: daily, hourly.

Responses

Dashboard data.

{
  "summary": {
    "total_requests": 123,
    "total_impressions": 123,
    "revenue": 12.34,
    "fill_rate": 12.34,
    "ecpm": 12.34,
    "total_clicks": 123,
    "ctr": 12.34,
    "total_users": 123,
    "xpromo_impressions": 123,
    "xpromo_clicks": 123
  },
  "chart_data": [
    {
      "bucket_start": "<string>",
      "date": "<string>",
      "requests": 123,
      "impressions": 123,
      "revenue": 12.34,
      "clicks": 123
    }
  ],
  "source_breakdown": [
    {
      "source": "<string>",
      "requests": 123,
      "impressions": 123,
      "revenue": 12.34,
      "fill_rate": 12.34,
      "ecpm": 12.34,
      "clicks": 123,
      "revenue_share": 12.34
    }
  ]
}

200Dashboard data.

Field	Type	Description
`summary`required	`object`
`chart_data`required	`array of object`
`source_breakdown`	`array of object`

400Invalid request parameters.

Field	Type	Description
`error`required	`string`

401Unauthorized.

Field	Type	Description
`error`required	`string`

403Forbidden.

Field	Type	Description
`error`required	`string`

500Internal server error.

Field	Type	Description
`error`required	`string`

504The query did not finish within the request time budget. Retry, narrowing the time range or filters where the operation accepts them.

Field	Type	Description
`error`required	`string`