report/bidders

GET/report/bidders

Fetch per-bidder performance for the requested time range. Requires the reports:read permission.

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/report/bidders?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.

Responses

Bidder performance data.

{
  "bidders": [
    {
      "name": "<string>",
      "requests": 123,
      "bids": 123,
      "bid_rate": 12.34,
      "impressions": 123,
      "win_rate": 12.34,
      "revenue": 12.34,
      "ecpm": 12.34
    }
  ]
}

200Bidder performance data.

Field	Type	Description
`bidders`required	`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`