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

> Fetch dashboard summary and chart data for the requested time range. Requires the `reports:read` permission.



## OpenAPI

````yaml https://provisioning.cloudx.io/api/v1/openapi.yaml get /report/dashboard
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/dashboard:
    get:
      tags:
        - Reporting
      summary: report/dashboard
      description: >-
        Fetch dashboard summary and chart data for the requested time range.
        Requires the `reports:read` permission.
      operationId: getReportDashboard
      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: 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: source
          description: >-
            Reporting source filter. Use `cloudx`, a mediation source such as
            `applovin`, a comma-separated list such as `cloudx,admob`, or `all`.
          schema:
            type: string
          example: cloudx
        - in: query
          name: granularity
          description: Reporting bucket size. Defaults to daily.
          schema:
            type: string
            enum:
              - daily
              - hourly
            default: daily
      responses:
        '200':
          description: Dashboard data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardResponse'
        '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:
    DashboardResponse:
      type: object
      required:
        - summary
        - chart_data
      properties:
        summary:
          $ref: '#/components/schemas/DashboardSummary'
        chart_data:
          type: array
          maxItems: 100000
          items:
            $ref: '#/components/schemas/DashboardChartRow'
        source_breakdown:
          type: array
          maxItems: 100000
          items:
            $ref: '#/components/schemas/SourceMetrics'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    DashboardSummary:
      type: object
      required:
        - total_requests
        - total_impressions
        - revenue
        - fill_rate
        - ecpm
        - total_clicks
        - ctr
        - total_users
      properties:
        total_requests:
          type: integer
          format: int64
        total_impressions:
          type: integer
          format: int64
        revenue:
          type: number
          format: double
        fill_rate:
          type: number
          format: double
        ecpm:
          type: number
          format: double
        total_clicks:
          type: integer
          format: int64
        ctr:
          type: number
          format: double
        total_users:
          type: integer
          format: int64
    DashboardChartRow:
      type: object
      required:
        - bucket_start
        - date
        - requests
        - impressions
        - revenue
        - clicks
      properties:
        bucket_start:
          type: string
        date:
          type: string
        requests:
          type: integer
          format: int64
        impressions:
          type: integer
          format: int64
        revenue:
          type: number
          format: double
        clicks:
          type: integer
          format: int64
    SourceMetrics:
      type: object
      required:
        - source
        - requests
        - impressions
        - revenue
        - fill_rate
        - ecpm
        - clicks
        - revenue_share
      properties:
        source:
          type: string
        requests:
          type: integer
          format: int64
        impressions:
          type: integer
          format: int64
        revenue:
          type: number
          format: double
        fill_rate:
          type: number
          format: double
        ecpm:
          type: number
          format: double
        clicks:
          type: integer
          format: int64
        revenue_share:
          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

````