Response
The following table describes the information that is available in the response.
Response Fields
Parameter | Required/Optional | Description |
---|---|---|
This method is used to obtain the CSAT conversation summary based on agents.
(TBD)
This section describes the information that is available in the request.
Method | URL | End Point |
---|---|---|
GET |
/public/{streamId}/analytics/csat/agents/summary |
Parameter | Required | Description | Type/Value |
---|---|---|---|
streamId * | Y | Stream ID (e.g. st-606c43de5e00ca5f4e27e38a) |
String |
Parameter | Required | Description | Type/Value |
---|---|---|---|
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] |
sortBy | N | sort by query in the form of field:desc/asc (for e.g., name:asc) | String |
limit | N |
Maximum limit of records |
Integer |
offset | N |
offset number |
Integer |
TBD
The following table describes the information that is available in the response.
Parameter | Required/Optional | Description |
---|---|---|
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
application/json
{
"results": [
{
"firstName": "first name",
"lastName": "last name",
"profImage": "http://example.com/x.png",
"userId": "u-afds-asdf-adf",
"verySatisfied": 10,
"satisfied": 20,
"neutral": 30,
"dissatisfied": 20,
"veryDissatisfied": 20
}
],
"offset": 1,
"limit": 10,
"hasMore": false
}