> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Run a read-only analytics query

> Run a read-only SQL query against the org-scoped `report_*` analytics views. Use when pulling session and performance metrics into your own reporting or BI tools.



## OpenAPI

````yaml post /reports/analytics
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /reports/analytics:
    post:
      summary: Run a read-only analytics query
      description: >-
        Run a read-only SQL query against the org-scoped `report_*` analytics
        views. Scoped to the calling organization and read-only, enforced
        server-side.
      operationId: runAnalyticsQuery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunReportQueryBody'
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunReportQueryResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    RunReportQueryBody:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/RunReportQueryBodyInput'
      type: object
      properties:
        sql:
          type: string
          minLength: 1
          maxLength: 100000
        parameters:
          default: []
          type: array
          items: {}
      required:
        - sql
    RunReportQueryResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/RunReportQueryResponseDto'
      type: object
      properties:
        rows:
          type: array
          items:
            type: object
            propertyNames:
              type: string
            additionalProperties: {}
        row_count:
          type: number
        truncated:
          type: boolean
      required:
        - rows
        - row_count
        - truncated
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.