Agent availability metrics
GET/v1/reports/agents/availability/metrics
Returns per-agent availability metrics for the selected date/time window, queues, and agents.
Query Parameters
from_datestring required
Start date (DD-MM-YYYY).
Example:06-05-2026
to_datestring required
End date (DD-MM-YYYY).
Example:17-05-2026
from_timestring
Start time (HH-MM-SS). Defaults to start of day.
Example:00-00-00
to_timestring
End time (HH-MM-SS). Defaults to end of day.
Example:23-59-59
time_zonestring required
Required UTC offset.
Example:+03:00
queuearray
Optional comma-separated queue numbers or names. Omit to include all workspace queues.
Example:1001,1002
agentarray
Optional comma-separated agent identifiers (extension number or name). Omit to include all workspace agents.
Example:2001,2002
Responses
Body
success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required
Example:200
messagestring required
Example:OK
detailsobject required
dataarray[object] required
agentstring required
answeredinteger required
failedinteger required
pause_timeinteger required
pausesinteger required
talk_timeinteger required
wrapup_timeinteger required
ahtnumber (float) required
failed_outinteger required
rejectedinteger required
sessionsinteger required
session_timeinteger required
session_percentnumber (float) required
paused_percentnumber (float) required
hold_timeinteger required
idle_timeinteger required
metaobject