Get CSAT conversation summary by channels

Overview

This method is used to obtain the CSAT conversation summary based on channels.

Request

This section describes the information that is available in the request.

Method	URL	End Point
GET		/public/{streamId}/analytics/csat/channels/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
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 Default value : 10	Integer
offset	N	offset number Default value : 0	Integer

Sample Request

TBD

Response

The following table describes the information that is available in the response.

Response Fields

Parameter	Required/Optional	Description

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Response

{
  "results": [
    {
      "channel": "rtm",
      "verySatisfied": 10,
      "satisfied": 20,
      "neutral": 30,
      "dissatisfied": 20,
      "veryDissatisfied": 20
    }
  ],
  "offset": 1,
  "limit": 10,
  "hasMore": false
}