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 agents in an agent group based on the source.
(TBD)
Request
This section describes the information that is available in the request.
| Method | URL | End Point |
|---|---|---|
GET |
/public/{streamId}/analytics/manager/agents/summary
|
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 |
|---|---|---|---|
| agentGroupIds[] | N | Agent group ids | array[string] |
| source | N |
Conversation source type (chat or call or both) |
String |
| sortBy | N | Sort by query in the form of field:desc/asc (for e.g., name:asc) | String |
| fromTime * | Y |
Date in ISO81 format (for e.g. 2021-03-31T12:01:00.000Z) |
Date |
| toTime * | Y |
Date in ISO81 format (for e.g. 2021-03-31T12:01:00.000Z) |
Date |
| limit | N |
Maximum number of Agent groups |
Integer |
| page | N |
Page number |
Integer |
| status[] | N |
Status of agent |
array[string] |
| subStatus[] | N |
subStatus of agent |
array[string] |
| channels[] | N |
Channel source |
array[string] |
| skillGroupIds[] | N |
skill group ids |
array[string] |
| skillIds[] | N | list of skill ids | array[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
{
"results": [
{
"firstName": "Amanda",
"lastName": "Jones",
"nickName": "Amanda",
"status": "available",
"stats": {
"resolved": 1,
"completed": 1,
"transferred": 1,
"dropOff": 1,
"total": 3
},
"realtime": {
"active": 1,
"idle": 1,
"overdue": 1,
"terminated": 1
},
"time": {
"resolution": 1,
"firstResponse": 1
},
"customers": {
"active": 1,
"queue": 1
},
"loadPercentage": 75
}
],
"page": 1,
"limit": 10,
"hasMore": true,
"totalPages": 1,
"totalResults": 1
}