Response
The following table describes the information that is available in the response.
Response Fields
| Field | Required | Description |
|---|---|---|
| total | ||
| transferred | ||
| active | ||
| queue | ||
| completed | ||
| dropOff | ||
| successRate | ||
| resolved |
Overview
This method is used to obtain the agents’ conversation counts.
Request
This section describes the information that is available in the request.
| Method | URL | End Point |
|---|---|---|
GET |
TBD |
/public/{streamId}/analytics/manager/agents/stats
|
Request Parameters
The following tables describe the 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 |
Sample Request
TBD
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response Content Type
application/json
Sample Response
{
"total": 10,
"transferred": 3,
"active": 5,
"queue": 5,
"completed": 5,
"dropOff": 2,
"successRate": 50,
"resolved": 5
}