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

> Fetch grouped reporting rows for the requested time range. Requires the `reports:read` permission.



## OpenAPI

````yaml https://provisioning.cloudx.io/api/v1/openapi.yaml get /report/breakdown
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/breakdown:
    get:
      tags:
        - Reporting
      summary: report/breakdown
      description: >-
        Fetch grouped reporting rows for the requested time range. Requires the
        `reports:read` permission.
      operationId: getReportBreakdown
      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: by
          description: >-
            Comma-separated breakdown dimensions. Supported values are `hour`,
            `day`, `week`, `month`, `country`, `os`, `app`, `ad_unit`, and
            `format`.
          required: true
          schema:
            type: string
          example: day,app
        - in: query
          name: metrics
          description: Comma-separated metric names to include in each breakdown row.
          required: true
          schema:
            type: string
          example: requests,impressions,revenue
        - 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: 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: granularity
          description: Reporting bucket size. Defaults to daily.
          schema:
            type: string
            enum:
              - daily
              - hourly
            default: daily
        - in: query
          name: top
          description: Return the top N rows sorted by the first requested metric.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
        - in: query
          name: bottom
          description: Return the bottom N rows sorted by the first requested metric.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
        - in: query
          name: having
          description: Metric filter expression, such as `revenue > 10`.
          schema:
            type: string
          example: revenue > 10
      responses:
        '200':
          description: CloudX breakdown data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BreakdownResponse'
        '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:
    BreakdownResponse:
      type: object
      required:
        - dimensions
        - metrics
        - rows
        - row_count
      properties:
        dimensions:
          type: array
          items:
            type: string
        metrics:
          type: array
          items:
            type: string
        rows:
          type: array
          maxItems: 100000
          items:
            $ref: '#/components/schemas/BreakdownRow'
        row_count:
          type: integer
          format: int64
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    BreakdownRow:
      type: object
      required:
        - dimensions
        - metrics
      properties:
        dimensions:
          type: object
          additionalProperties:
            type: string
        metrics:
          type: object
          additionalProperties:
            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

````