Skip to main content
GET
/
auction
/
list
auction/list
curl --request GET \
  --url https://provisioning.cloudx.io/api/v1/auction/list \
  --header 'Authorization: Bearer <token>'
{
  "auctions": [
    {
      "auction_id": "<string>",
      "account_id": "<string>",
      "event_time": "<string>",
      "app_bundle": "<string>",
      "app_name": "<string>",
      "ad_unit_id": "<string>",
      "imp_count": 123,
      "device_os": "<string>",
      "device_country": "<string>",
      "sdk_version": "<string>",
      "test_mode": true,
      "status": 123,
      "priority": 123,
      "has_winner": true,
      "winner_bidder": "<string>",
      "winner_price_cpm": 123,
      "bidder_count": 123,
      "bid_count": 123,
      "nonbid_count": 123,
      "auction_duration_ms": 123,
      "error": "<string>",
      "ab_test_id": "<string>",
      "ab_test_variant": "<string>",
      "inserted_at": "<string>",
      "has_ilrd": true,
      "has_external_ilrd": true,
      "external_ilrd_count": 123,
      "external_revenue": 123,
      "external_mediators": [
        "<string>"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.cloudx.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
default:YOUR_CLOUDX_API_KEY
required

Create or manage API keys in CloudX Settings.

Query Parameters

start_time
integer<int64>
required

Start of the time range as a Unix timestamp in seconds. The requested range must not exceed 31 days.

end_time
integer<int64>
required

End of the time range as a Unix timestamp in seconds. The requested range must not exceed 31 days.

test_mode
enum<string>
default:production

Traffic mode to include. Defaults to production traffic.

Available options:
production,
test,
all
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
enum<string>

Device operating system filter.

Available options:
iOS,
Android
limit
integer<int32>
default:50

Maximum number of rows to return.

Required range: 1 <= x <= 500
has_ilrd
boolean

Filter to auctions that have CloudX ILRD.

has_external_ilrd
boolean

Filter to auctions that have external ILRD.

mediator
enum<string>

Mediation platform filter.

Available options:
applovin,
admob,
levelplay

Response

Matching auctions.

auctions
object[]
required
Maximum array length: 500