Response
The following table describes the information that is available in the response.
Response Fields
| Parameter | Required/Optional | Description |
|---|---|---|
Overview
This method is used to obtain the conversation summary.
(TBD)
Request
This section describes the information that is available in the request.
| Method | URL | End Point |
|---|---|---|
GET |
/public/{streamId}/analytics/conversations/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 |
|---|---|---|---|
| source | N | Conversation source – chat or call | String |
| startDate * | Y | Date in ISO81 format (e.g.. 2021-03-31T12:01:00.000Z) |
Date |
| endDate * | Y | Date in ISO81 format | Date |
| agentGroupIds[] | N | Agent group ids | array[string] |
| agentIds[] | N | List of user ids | array[string] |
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
{
"resolved": 10,
"unResolved": 20,
"transferred": 30,
"dropOff": 20
}