auction/rounds

GET/auction/rounds

Inspect rounds for an auction or aggregate round metrics. Requires the auctions:read permission.

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/auction/rounds" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Query parameters

Name	Type	Description
`auction_id`	`string`	CloudX auction ID.
`start_time`	`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`	`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.
`metric`	`string`	Aggregate round metric to return when `auction_id` is omitted. Allowed values: distribution, duration, cleared-on, skip-reason.
`test_mode`	`string`	Traffic mode to include. Defaults to production traffic. Allowed values: 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`	`string`	Device operating system filter. Allowed values: iOS, Android.
`limit`	`integer<int32>`	Maximum number of rows to return.

Responses

Auction round rows or aggregate metrics.

{
  "rounds": [
    {
      "auction_id": "<string>",
      "round_id": "<string>",
      "round_number": 123,
      "priority": 123,
      "account_id": "<string>",
      "event_time": "<string>",
      "app_bundle": "<string>",
      "app_name": "<string>",
      "ad_unit_id": "<string>",
      "device_os": "<string>",
      "device_country": "<string>",
      "sdk_version": "<string>",
      "test_mode": true,
      "line_item_count": 123,
      "bidder_count": 123,
      "bid_count": 123,
      "nonbid_count": 123,
      "bid_sum": 12.34,
      "has_winner": true,
      "winner_bidder": "<string>",
      "winner_line_item_id": "<string>",
      "winner_price_cpm": 12.34,
      "configured_floor": 12.34,
      "round_floor": 12.34,
      "floor_currency": "<string>",
      "dps_model": "<string>",
      "dps_model_version": "<string>",
      "experiment_group": "<string>",
      "shadow_mode": true,
      "round_duration_ms": 123
    }
  ],
  "metrics": [
    {
      "metric": "<string>",
      "key": "<string>",
      "round_number": 123,
      "count": 123,
      "avg_duration_ms": 12.34,
      "p50_duration_ms": 12.34,
      "p95_duration_ms": 12.34,
      "max_duration_ms": 123,
      "status": "<string>",
      "nonbid_reason": 123,
      "error_type": "<string>",
      "rejection_reason": "<string>"
    }
  ]
}

200Auction round rows or aggregate metrics.

Field	Type	Description
`rounds`required	`array of object`
`metrics`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`