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

# Get impact report

> Get impact report — Get the AI automation rate and resolution breakdown. Use when pulling impact metrics into your own reporting.



## OpenAPI

````yaml get /impact-report
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:
  /impact-report:
    get:
      summary: Get impact report
      description: >-
        Get the AI automation rate and resolution breakdown. Returns total
        resolved, assumed resolved, handed off, and in-progress sessions along
        with the computed automation rate percentage, plus per-day resolution
        (`resolutions_daily`), per-day automation rate
        (`automation_rate_daily`), and sentiment (`sentiments_daily`) counts and
        the resolution totals (`resolution_totals`) and sentiment totals
        (`sentiment_totals`) for charting.
      operationId: getImpactReport
      parameters:
        - schema:
            type: string
          in: query
          name: start_date
          required: false
          description: >-
            Start date in ISO 8601 format; a date-only value starts at 00:00 UTC
            (defaults to 30 days before the end)
        - schema:
            type: string
          in: query
          name: end_date
          required: false
          description: >-
            End date in ISO 8601 format; a date-only value covers the whole UTC
            day (defaults to now)
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImpactReportResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    ImpactReportResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/ImpactReportResponseDto'
      type: object
      properties:
        start_date:
          type: string
        end_date:
          type: string
        total_resolved:
          type: number
        total_assumed_resolved:
          type: number
        total_handed_off:
          type: number
        total_in_progress:
          type: number
        automation_rate:
          type: number
        resolutions_daily:
          type: array
          items:
            type: object
            properties:
              day:
                type: string
              resolved:
                type: number
              assumed_resolved:
                type: number
              handed_off:
                type: number
              in_progress:
                type: number
            required:
              - day
              - resolved
              - assumed_resolved
              - handed_off
              - in_progress
            additionalProperties: false
        automation_rate_daily:
          type: array
          items:
            type: object
            properties:
              day:
                type: string
              automation_rate:
                type: number
            required:
              - day
              - automation_rate
            additionalProperties: false
        sentiments_daily:
          type: array
          items:
            type: object
            properties:
              day:
                type: string
              happy:
                type: number
              neutral:
                type: number
              angry:
                type: number
              in_progress:
                type: number
            required:
              - day
              - happy
              - neutral
              - angry
              - in_progress
            additionalProperties: false
        resolution_totals:
          type: object
          properties:
            resolved:
              type: number
            assumed_resolved:
              type: number
            handed_off:
              type: number
            in_progress:
              type: number
          required:
            - resolved
            - assumed_resolved
            - handed_off
            - in_progress
          additionalProperties: false
        sentiment_totals:
          type: object
          properties:
            happy:
              type: number
            neutral:
              type: number
            angry:
              type: number
            in_progress:
              type: number
          required:
            - happy
            - neutral
            - angry
            - in_progress
          additionalProperties: false
      required:
        - start_date
        - end_date
        - total_resolved
        - total_assumed_resolved
        - total_handed_off
        - total_in_progress
        - automation_rate
        - resolutions_daily
        - automation_rate_daily
        - sentiments_daily
        - resolution_totals
        - sentiment_totals
      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.