Skip to content

Distribution metrics grouped by time period

GET/v1/reports/distribution/by-time/metrics

Returns aggregate distribution KPIs grouped by `period` for the full filter window. Use `/details` for paginated call rows. Private upstream path: `/v1/reports/distribution/by-time/metrics`.

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:text
agentarray

Optional comma-separated agent identifiers. Omit to include all workspace agents.

Example:text
periodstring required

Calendar bucket for subdividing the filter window. Wire `week_day` maps to legacy `weekDay` group.

Example:month