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

# Admin Agent Availability

> Get agent availability metrics for a queue with optional time distribution



## OpenAPI

````yaml https://api.voxo.co/v2/docs/openapi.json post /v2/admin/reporting/queues/agent-availability
openapi: 3.1.0
info:
  title: VOXO API
  description: VOXO Communication Platform API
  version: 2.0.0
servers:
  - url: https://api.voxo.co
security:
  - bearerAuth: []
paths:
  /v2/admin/reporting/queues/agent-availability:
    post:
      tags:
        - Reporting - Queues
      summary: Admin Agent Availability
      description: >-
        Get agent availability metrics for a queue with optional time
        distribution
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                users:
                  description: Filter by user peer names, or 'ALL' for all users
                  anyOf:
                    - type: array
                      items:
                        type: string
                    - type: string
                      enum:
                        - ALL
                queueId:
                  type: number
                  exclusiveMinimum: 0
                  description: Queue ID
                startDate:
                  type: string
                  description: Start date for the report period
                endDate:
                  type: string
                  description: End date for the report period
                distribution:
                  description: >-
                    Time distribution grouping (daily, weekly, monthly, or
                    totals)
                  anyOf:
                    - type: string
                      enum:
                        - weekly
                    - type: string
                      enum:
                        - daily
                    - type: string
                      enum:
                        - monthly
                    - type: string
                      enum:
                        - totals
              required:
                - queueId
                - startDate
                - endDate
              additionalProperties: false
      responses:
        '200':
          description: Agent availability results
          content:
            application/json:
              schema:
                anyOf:
                  - type: array
                    items:
                      type: object
                      properties:
                        peerName:
                          type: string
                          description: Agent peer name
                        name:
                          description: Agent display name
                          type: string
                        queueTalkTime:
                          type: number
                          description: Queue talk time in seconds
                        nonQueueTalkTime:
                          type: number
                          description: Non-queue talk time in seconds
                        totalUnavailableTime:
                          type: number
                          description: Total unavailable time in seconds
                        totalAvailableTime:
                          type: number
                          description: Total available time in seconds
                        offDutyTimes:
                          type: array
                          items:
                            type: object
                            properties:
                              offDutyReason:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                                description: Reason for being off duty
                              offDutyTime:
                                type: number
                                description: Off duty duration in seconds
                            required:
                              - offDutyReason
                              - offDutyTime
                            additionalProperties: false
                          description: Breakdown of off-duty periods
                        dndTimes:
                          type: number
                          description: Do not disturb time in seconds
                      required:
                        - peerName
                        - name
                        - queueTalkTime
                        - nonQueueTalkTime
                        - totalUnavailableTime
                        - totalAvailableTime
                        - offDutyTimes
                        - dndTimes
                      additionalProperties: false
                  - type: array
                    items:
                      type: object
                      properties:
                        distribution:
                          type: string
                          description: Distribution date/period
                        results:
                          type: object
                          properties:
                            dndTime:
                              type: number
                              description: Do not disturb time in seconds
                            queueTalkTime:
                              type: number
                              description: Queue talk time in seconds
                            nonQueueTalkTime:
                              type: number
                              description: Non-queue talk time in seconds
                            availableTime:
                              type: number
                              description: Available time in seconds
                            unavailableTime:
                              type: number
                              description: Unavailable time in seconds
                            offDutyTimes:
                              type: array
                              items:
                                type: object
                                properties:
                                  offDutyReason:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                    description: Reason for being off duty
                                  offDutyTime:
                                    type: number
                                    description: Off duty duration in seconds
                                required:
                                  - offDutyReason
                                  - offDutyTime
                                additionalProperties: false
                              description: Breakdown of off-duty periods
                          required:
                            - dndTime
                            - queueTalkTime
                            - nonQueueTalkTime
                            - availableTime
                            - unavailableTime
                            - offDutyTimes
                          additionalProperties: false
                      required:
                        - distribution
                        - results
                      additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````