Get customer happiness count
GET {{baseUrl}}/v1/customerHappiness/count?department=<String>
This API gives you the count of the ratings given by the customers for each category of a given department. You can also use any one of the sub modules: agentId, contactId, accountId, or ticketId at a time.
OAuth Scope
Desk.tickets.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
department | string | Mandatory param to fetch the customer-happiness list for a given ID of a department. You can also provide department as allDepartment to fetch customer-happiness list from all the departments | |
agentId | string | Filter that returns the customer-ratings count for a particular agent | |
contactId | string | Filter that returns the customer-ratings count for a particular contact | |
accountId | string | Filter that returns the customer-ratings count for a particular account | |
ticketId | string | Filter that returns the customer-ratings count for a particular ticket | |
startTime | string | Start time from which the customer-happiness list should show. Start time should be in GMT time zone and in milliseconds | |
endTime | string | Start time till which the customer-happiness list should show. Start time should be in GMT time zone and in milliseconds | |
duration | string | Period from which the customer happiness rating must be fetched. Values allowed are: TODAY , THIS_WEEK , LAST_WEEK , THIS_MONTH , LAST_MONTH , LAST_7_DAYS , YESTERDAY , LAST_1_HOUR , CUSTOM_IN_DATE , LAST_100_RATINGS , LAST24HOURS and LAST_30_DAYS | |
startDate | string | start date time | |
endDate | string | end date time | |
from | string | The from index | |
limit | string | Number of rating to be displayed |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"30000002344":{"bad":3,"ok":2,"good":5}}