User Agent Availability

Get agent availability metrics for the authenticated user’s queue

POST /v2/reporting/queues/agent-availability

User Agent Availability

cURL

curl --request POST \
  --url https://api.voxo.co/v2/reporting/queues/agent-availability \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "queueId": 1,
  "startDate": "<string>",
  "endDate": "<string>"
}
'

200

[
  {
    "peerName": "<string>",
    "name": "<string>",
    "queueTalkTime": 123,
    "nonQueueTalkTime": 123,
    "totalUnavailableTime": 123,
    "totalAvailableTime": 123,
    "offDutyTimes": [
      {
        "offDutyReason": "<string>",
        "offDutyTime": 123
      }
    ],
    "dndTimes": 123
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

queueId · number · required

Queue ID

Required range: x > 0

startDate · string · required

Start date for the report period

endDate · string · required

End date for the report period

distribution · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string>

Time distribution grouping (daily, weekly, monthly, or totals)

Available options: weekly

Response

200

application/json

Agent availability results

peerName · string · required

Agent peer name

name · string · required

Agent display name

queueTalkTime · number · required

Queue talk time in seconds

nonQueueTalkTime · number · required

Non-queue talk time in seconds

totalUnavailableTime · number · required

Total unavailable time in seconds

totalAvailableTime · number · required

Total available time in seconds

offDutyTimes · object[] · required

Breakdown of off-duty periods

Show child attributes

dndTimes · number · required

Do not disturb time in seconds