> ## 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/bids

> List bid and non-bid rows matching the requested filters. Requires the `auctions:read` permission.



## OpenAPI

````yaml https://provisioning.cloudx.io/api/v1/openapi.yaml get /auction/bids
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/bids:
    get:
      tags:
        - Auction Inspection
      summary: auction/bids
      description: >-
        List bid and non-bid rows matching the requested filters. Requires the
        `auctions:read` permission.
      operationId: getAuctionBids
      parameters:
        - 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.
          required: true
          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.
          required: true
          schema:
            type: integer
            format: int64
          example: 1712534399
        - 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
        - in: query
          name: floor_source
          description: Floor source filter.
          schema:
            type: string
            enum:
              - static
              - dynamic
              - publisher
              - configured
      responses:
        '200':
          description: Matching bid rows.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuctionBidsResponse'
        '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:
    AuctionBidsResponse:
      type: object
      required:
        - bids
      properties:
        bids:
          type: array
          maxItems: 500
          items:
            $ref: '#/components/schemas/AuctionBid'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    AuctionBid:
      type: object
      required:
        - auction_id
        - account_id
        - event_time
        - bidder
        - bid_id
        - imp_id
        - price_cpm
        - deal_id
        - is_winner
        - app_bundle
        - ad_unit_id
        - device_os
        - device_country
        - sdk_version
        - test_mode
        - status
        - nonbid_reason
        - static_floor
        - configured_floor
        - dynamic_floor
        - publisher_floor
        - publisher_floor_applied
        - effective_floor
        - effective_floor_source
        - publisher_override_active
        - http_status
        - latency_ms
        - error_type
        - rejection_reason
        - round_number
        - priority
        - inserted_at
      properties:
        auction_id:
          type: string
        account_id:
          type: string
        event_time:
          type: string
        bidder:
          type: string
        bid_id:
          type: string
        imp_id:
          type: string
        price_cpm:
          type: number
          format: double
        deal_id:
          type: string
        is_winner:
          type: boolean
        app_bundle:
          type: string
        ad_unit_id:
          type: string
        device_os:
          type: string
        device_country:
          type: string
        sdk_version:
          type: string
        test_mode:
          type: boolean
        status:
          type: string
        nonbid_reason:
          type: integer
          format: int32
        static_floor:
          type: number
          format: double
        configured_floor:
          type: number
          format: double
        dynamic_floor:
          type: number
          format: double
        publisher_floor:
          type: number
          format: double
        publisher_floor_applied:
          type: boolean
        effective_floor:
          type: number
          format: double
        effective_floor_source:
          type: string
        publisher_override_active:
          type: boolean
        http_status:
          type: integer
          format: int32
        latency_ms:
          type: integer
          format: int64
        error_type:
          type: string
        rejection_reason:
          type: string
        round_number:
          type: integer
          format: int32
        priority:
          type: integer
          format: int32
        inserted_at:
          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

````