Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response Content Type
application/json
Overview
This method is used to fetch the statuses of Agent Desktop queues.
(TBD)
Request
This section describes the information that is available in the request
| Method | URL | End Point |
|---|---|---|
GET |
/public/{streamId}/analytics/queue
|
Request Parameters
Path Parameters
| Parameter | Required | Description | Type/Value |
|---|---|---|---|
| streamId * | Y | Stream ID (e.g. st-606c43de5e00ca5f4e27e38a) |
String |
Query Parameters
| Parameter | Required | Description | Type/Value |
|---|---|---|---|
| metrics | N | Comma separated widget list | String |
| startDate * | Y | Date in ISO81 format (e.g.. 2021-03-31T12:01:00.000Z) |
Date |
| endDate * | Y | Date in ISO81 format | Date |
| compareStartDate | N | Date in ISO81 format | Date |
| compareEndDate | N | Date in ISO81 format | Date |
| agentGroupIds[] | N | Agent group ids | String |
| agentIds[] | N | List of user ids | String |
Sample Request
TBD
Response
The following table describes the information that is available in the response.
Response Fields
| Parameter | Required/Optional | Description |
|---|---|---|
Sample Response
{
"queue": [
{
"previous": 10,
"total": 10,
"voice": 10,
"chat": 10,
"email": 10,
"time": "2021-03-31T12:01:00.000Z"
}
],
"averageWaitTime": {
"total": 10,
"percentageChange": 10,
"previous": 10
}
}[/vc_column][/vc_row]