> ## 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.

# auction/rounds

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



## OpenAPI

````yaml https://provisioning.cloudx.io/api/v1/openapi.yaml get /auction/rounds
openapi: 3.0.3
info:
  title: CloudX API
  description: >-
    Use the CloudX API to retrieve reporting metrics, inspect auctions, and read
    account configuration.
  version: 1.0.0
servers:
  - url: https://provisioning.cloudx.io/api/v1
security: []
tags:
  - name: Authentication
    description: Validate CloudX API keys and inspect authenticated account details.
  - name: Reporting
    description: >-
      Retrieve CloudX reporting metrics for apps, ad units, bidders, and
      exports.
  - name: Configuration
    description: Read live, draft, and published CloudX account configuration.
  - name: Auction Inspection
    description: Inspect auctions, rounds, bids, and related delivery details.
paths:
  /auction/rounds:
    get:
      tags:
        - Auction Inspection
      summary: auction/rounds
      description: >-
        Inspect rounds for an auction or aggregate round metrics. Requires the
        `auctions:read` permission.
      operationId: getAuctionRounds
      parameters:
        - in: query
          name: auction_id
          description: CloudX auction ID.
          schema:
            type: string
          example: auction_123
        - in: query
          name: start_time
          description: >-
            Start of the time range as a Unix timestamp in seconds. The
            requested range must not exceed 31 days.
          schema:
            type: integer
            format: int64
          example: 1712448000
        - in: query
          name: end_time
          description: >-
            End of the time range as a Unix timestamp in seconds. The requested
            range must not exceed 31 days.
          schema:
            type: integer
            format: int64
          example: 1712534399
        - in: query
          name: metric
          description: Aggregate round metric to return when `auction_id` is omitted.
          schema:
            type: string
            enum:
              - distribution
              - duration
              - cleared-on
              - skip-reason
        - in: query
          name: test_mode
          description: Traffic mode to include. Defaults to production traffic.
          schema:
            type: string
            enum:
              - production
              - test
              - all
            default: production
        - in: query
          name: app_bundle
          description: App bundle identifier filter.
          schema:
            type: string
          example: com.example.game
        - in: query
          name: ad_unit_id
          description: Ad unit ID filter.
          schema:
            type: string
        - in: query
          name: country
          description: ISO 3166-1 alpha-2 country code filter.
          schema:
            type: string
          example: US
        - in: query
          name: device_os
          description: Device operating system filter.
          schema:
            type: string
            enum:
              - iOS
              - Android
        - in: query
          name: limit
          description: Maximum number of rows to return.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 500
            default: 50
          example: 50
      responses:
        '200':
          description: Auction round rows or aggregate metrics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuctionRoundsResponse'
        '400':
          description: Invalid request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    AuctionRoundsResponse:
      type: object
      required:
        - rounds
        - metrics
      properties:
        rounds:
          type: array
          maxItems: 500
          items:
            $ref: '#/components/schemas/AuctionRound'
        metrics:
          type: array
          maxItems: 500
          items:
            $ref: '#/components/schemas/AuctionRoundMetric'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    AuctionRound:
      type: object
      required:
        - auction_id
        - round_id
        - round_number
        - priority
        - account_id
        - event_time
        - app_bundle
        - app_name
        - ad_unit_id
        - device_os
        - device_country
        - sdk_version
        - test_mode
        - line_item_count
        - bidder_count
        - bid_count
        - nonbid_count
        - bid_sum
        - has_winner
        - winner_bidder
        - winner_line_item_id
        - winner_price_cpm
        - configured_floor
        - round_floor
        - floor_currency
        - dps_model
        - dps_model_version
        - experiment_group
        - shadow_mode
        - round_duration_ms
      properties:
        auction_id:
          type: string
        round_id:
          type: string
        round_number:
          type: integer
          format: int32
        priority:
          type: integer
          format: int32
        account_id:
          type: string
        event_time:
          type: string
        app_bundle:
          type: string
        app_name:
          type: string
        ad_unit_id:
          type: string
        device_os:
          type: string
        device_country:
          type: string
        sdk_version:
          type: string
        test_mode:
          type: boolean
        line_item_count:
          type: integer
          format: int32
        bidder_count:
          type: integer
          format: int32
        bid_count:
          type: integer
          format: int32
        nonbid_count:
          type: integer
          format: int32
        bid_sum:
          type: number
          format: double
        has_winner:
          type: boolean
        winner_bidder:
          type: string
        winner_line_item_id:
          type: string
        winner_price_cpm:
          type: number
          format: double
        configured_floor:
          type: number
          format: double
        round_floor:
          type: number
          format: double
        floor_currency:
          type: string
        dps_model:
          type: string
        dps_model_version:
          type: string
        experiment_group:
          type: string
        shadow_mode:
          type: boolean
        round_duration_ms:
          type: integer
          format: int64
    AuctionRoundMetric:
      type: object
      required:
        - metric
        - key
        - round_number
        - count
        - avg_duration_ms
        - p50_duration_ms
        - p95_duration_ms
        - max_duration_ms
        - status
        - nonbid_reason
        - error_type
        - rejection_reason
      properties:
        metric:
          type: string
        key:
          type: string
        round_number:
          type: integer
          format: int32
        count:
          type: integer
          format: int64
        avg_duration_ms:
          type: number
          format: double
        p50_duration_ms:
          type: number
          format: double
        p95_duration_ms:
          type: number
          format: double
        max_duration_ms:
          type: integer
          format: int64
        status:
          type: string
        nonbid_reason:
          type: integer
          format: int32
        error_type:
          type: string
        rejection_reason:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Create or manage API keys in [CloudX
        Settings](https://app.cloudx.io/settings/api-keys).
      x-default: YOUR_CLOUDX_API_KEY

````