Management APIReferenceQueues

GetACDOperatorStatusStatistics

View as Markdown
Get statistics for the specified operators and ACD statuses. This method can filter statistics by operator ids and statuses. It can also group results by day/hour or users. Allowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `User manager`. **Example request:** Get statistics for the 'READY' and 'ONLINE' statuses of all operators; grouped by operators.

Authentication

AuthorizationBearer
Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

from_datestringRequired

Date and time of statistics interval begin. Time zone is UTC, format is 24-h ‘YYYY-MM-DD HH:mm:ss’

to_datestringOptionalDefaults to current date and time

Date and time of statistics interval begin. Time zone is UTC, format is 24-h ‘YYYY-MM-DD HH:mm:ss’

acd_statuslist of stringsOptional

The ACD status list separated by semicolons (;). The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND

user_idlist of stringsRequired

The user ID list separated by semicolons (;). Use the ‘all’ value to select all users

aggregationstringOptionalDefaults to none

Specifies how records are grouped by date and time. If set to ‘day’, the criteria is a day number. If set to ‘hour_of_day’, the criteria is a 60-minute interval within a day. If set to ‘hour’, the criteria is both day number and 60-minute interval within that day. If set to ‘none’, records are not grouped by date and time

groupstringOptionalDefaults to user

If set to ‘user’, first-level array in the resulting JSON groups records by the user ID, and second-level array groups them by date according to the ‘aggregation’ parameter. If set to ‘aggregation’, first-level array in the resulting JSON groups records according to the ‘aggregation’ parameter, and second-level array groups them by the user ID

Response

Successful response
resultlist of objects
List of groups, grouped by user ID or date according to the 'group' method call argument