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

# report/ab-test

> Fetch A/B test metrics split by control and test variants. Requires the `reports:read` permission.



## OpenAPI

````yaml https://provisioning.cloudx.io/api/v1/openapi.yaml get /report/ab-test
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:
  /report/ab-test:
    get:
      tags:
        - Reporting
      summary: report/ab-test
      description: >-
        Fetch A/B test metrics split by control and test variants. Requires the
        `reports:read` permission.
      operationId: getReportABTest
      parameters:
        - in: query
          name: ab_test_id
          description: A/B test ID to report.
          required: true
          schema:
            type: string
          example: abtest_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.
          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
      responses:
        '200':
          description: A/B test metrics split by variant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ABTestReportResponse'
        '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:
    ABTestReportResponse:
      type: object
      required:
        - control
        - test
      properties:
        control:
          $ref: '#/components/schemas/ABTestVariantMetrics'
        test:
          $ref: '#/components/schemas/ABTestVariantMetrics'
        status:
          type: string
          nullable: true
          description: >-
            Latest snapshot status (in_progress, directional, achieved,
            invalidated).
        lift:
          type: number
          format: double
          nullable: true
        ci_low:
          type: number
          format: double
          nullable: true
        ci_high:
          type: number
          format: double
          nullable: true
        p_value:
          type: number
          format: double
          nullable: true
        n_control:
          type: integer
          format: int64
          nullable: true
        n_test:
          type: integer
          format: int64
          nullable: true
        required_n:
          type: integer
          format: int64
          nullable: true
        chi_squared_p:
          type: number
          format: double
          nullable: true
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    ABTestVariantMetrics:
      type: object
      required:
        - daily
        - cumulative
      properties:
        daily:
          type: array
          maxItems: 100000
          items:
            $ref: '#/components/schemas/ABTestDailyMetrics'
        cumulative:
          $ref: '#/components/schemas/ABTestCumulativeMetrics'
    ABTestDailyMetrics:
      type: object
      required:
        - date
        - revenue
        - impressions
        - requests
        - ecpm
        - fill_rate
        - dau
      properties:
        date:
          type: string
          description: UTC date for this metrics bucket.
          example: '2026-03-01'
        revenue:
          type: number
          format: double
        impressions:
          type: integer
          format: int64
        requests:
          type: integer
          format: int64
        ecpm:
          type: number
          format: double
        fill_rate:
          type: number
          format: double
        dau:
          type: integer
          format: int64
    ABTestCumulativeMetrics:
      type: object
      required:
        - revenue
        - impressions
        - requests
        - ecpm
        - fill_rate
      properties:
        revenue:
          type: number
          format: double
        impressions:
          type: integer
          format: int64
        requests:
          type: integer
          format: int64
        ecpm:
          type: number
          format: double
        fill_rate:
          type: number
          format: double
  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

````