Distribution by time period metrics
GET/v1/reports/distribution/by-time/metrics
Returns distribution metrics grouped by the requested time period 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
UTC offset. Defaults to +00:00 when omitted.
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
periodstring required
Calendar bucket for subdividing the filter window. Use week_day to group results by weekday.
Example:day
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
groupenum: month | week | day | hour | weekDay•Display name for the time-period group. required
namestring•Bucket key (e.g. 2026-01-15 for day, 00:00 - 00:59 for hour, Monday for week_day). required
queue_namestring or null•Always null for temporal buckets (aggregates span queues). required
queue_numberstring or null•Always null for temporal buckets. required
receivedinteger required
answeredinteger required
unansweredinteger required
abandonedinteger required
transferredinteger required
loginsinteger required
logoffinteger required
avg_waitnumber (float) required
avg_talknumber (float) required
max_callersinteger required
answered_percentagenumber (float) required
unanswered_percentagenumber (float) required
transferred_percentagenumber (float) required
abandoned_percentagenumber (float) required
slanumber (float) required
metaobject