> ## 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 a heatmap of SLA breaches by hour of day and day of week. Use when pulling SLA-adherence metrics into a reporting system.

# Get SLA breach heatmap



## OpenAPI

````yaml get /sla/analytics/breach-heatmap
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: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /sla/analytics/breach-heatmap:
    get:
      summary: Get SLA breach heatmap
      description: Get a heatmap of SLA breaches by hour of day and day of week.
      operationId: getSlaBreachHeatmap
      parameters:
        - schema: {}
          in: query
          name: from
          required: true
        - schema: {}
          in: query
          name: to
          required: true
        - schema:
            default: UTC
            type: string
          in: query
          name: timezone
          required: false
        - schema:
            type: string
          in: query
          name: policy_id
          required: false
        - schema:
            type: string
          in: query
          name: team_id
          required: false
        - schema:
            type: string
            enum:
              - web
              - email
              - phone_voice
              - slack
              - sms
              - whatsapp
              - instagram
              - messenger
              - api
              - web_voice
          in: query
          name: channel
          required: false
        - schema:
            type: number
          in: query
          name: agent_id
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlaBreachHeatmapResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    SlaBreachHeatmapResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SlaBreachHeatmapResponseDto'
      type: object
      properties:
        timezone:
          type: string
        data:
          type: array
          items:
            type: object
            properties:
              day_of_week:
                type: integer
                minimum: 0
                maximum: 6
              hour:
                type: integer
                minimum: 0
                maximum: 23
              breaches:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
            required:
              - day_of_week
              - hour
              - breaches
            additionalProperties: false
      required:
        - timezone
        - data
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````