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

KeyDatatypeRequiredDescription
departmentstringMandatory 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
agentIdstringFilter that returns the customer-ratings count for a particular agent
contactIdstringFilter that returns the customer-ratings count for a particular contact
accountIdstringFilter that returns the customer-ratings count for a particular account
ticketIdstringFilter that returns the customer-ratings count for a particular ticket
startTimestringStart time from which the customer-happiness list should show. Start time should be in GMT time zone and in milliseconds
endTimestringStart time till which the customer-happiness list should show. Start time should be in GMT time zone and in milliseconds
durationstringPeriod 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
startDatestringstart date time
endDatestringend date time
fromstringThe from index
limitstringNumber of rating to be displayed

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;30000002344&quot;:{&quot;bad&quot;:3,&quot;ok&quot;:2,&quot;good&quot;:5}}