auction/list

GET/auction/list

List recent auctions matching the requested filters. Requires the auctions:read permission.

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/auction/list?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.
`test_mode`	`string`	Traffic mode to include. Defaults to production traffic.
`app_bundle`	`string`	App bundle identifier filter.
`ad_unit_id`	`string`	Ad unit ID filter.
`country`	`string`	ISO 3166-1 alpha-2 country code filter.
`device_os`	`string`	Device operating system filter.
`limit`	`integer<int32>`	Maximum number of rows to return.
`has_ilrd`	`boolean`	Filter to auctions that have CloudX ILRD.
`has_external_ilrd`	`boolean`	Filter to auctions that have external ILRD.
`mediator`	`string`	Mediation platform filter.

Responses

Matching auctions.

{
  "auctions": [
    "<string>"
  ]
}

200 Matching auctions.

Field	Type	Description
`auctions`required	`array of object`

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`