List all customerHappiness
GET {{baseUrl}}/v1/customerHappiness?department=<String>
Get customer-happiness list for a given department. You can also use any one of the sub modules: agentId, contactId, accountId, or ticketId at a time.
OAuth Scope
Desk.search.READDesk.tickets.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
department | string | Mandatory param to fetch the customer-happiness list for a given ID of the department. You can also provide department as allDepartment to fetch customer happiness from all departments | |
agentId | string | Filter that returns the customer-happiness list for a particular agent | |
contactId | string | Filter that returns the customer-happiness list for a particular contact | |
accountId | string | Filter that returns the customer-happiness list for a particular account | |
ticketId | string | Filter that returns the customer-happiness list 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. End time should be in GMT time zone and in milliseconds | |
from | string | The startng index from which the list should be displayed based on the time of receiving customer feedback | |
limit | string | Number of ratings to be displayed in the list | |
rating | string | Segregate the list based on the type of rating. Allowed values are good, ok, or bad | |
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 | |
sortBy | string | Sorted by ratedtime | |
include | string | Allowed values are : contacts, tickets, agents. You can include both by separating them with a comma in the query param. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"agentId":"5000000015959","agent":{"firstName":"dasca","lastName":"vins","photoURL":"https://desk.zoho.com/api/v1/agent/5000000015959/photo","id":"5000000015959","email":"jack@zylker.com"},"ticket":{"ticketNumber":"118","subject":"GPS not working","id":"5000000074060"},"contactId":"5000000017055","departmentId":"5000000056329","rating":"GOOD","threadId":"5000000090001","feedback":"Great Work!!!","accountId":"5000000017043","ratedTime":"2021-12-02T14:36:20.291Z","customerRatedTime":"2021-12-02T09:06:20.291Z","timezoneOffset":"GMT +5:30","contact":{"name":"Nirmal Kumar","id":"5000000017055"},"id":"5000000090012","ticketId":"5000000074060"},{"agentId":"5000000015959","agent":{"firstName":"dasca","lastName":"vins","photoURL":"https://desk.zoho.com/api/v1/agent/5000000015959/photo","id":"5000000015959","email":"jack@zylker.com"},"ticket":{"ticketNumber":"117","subject":"Apps take time to load","id":"5000000056151"},"contactId":"5000000026602","departmentId":"5000000042101","rating":"BAD","threadId":"5000000092045","feedback":"The solution provided doesn't seem to work.","accountId":"-1","ratedTime":"2018-09-26T10:47:35.936Z","timezoneOffset":"GMT +5:30","contact":{"name":"Phillip Collins","id":"5000000026602"},"id":"5000000092056","ticketId":"5000000056151"},{"agentId":"5000000015959","ticket":{"ticketNumber":"114","subject":"zPhone battery needs to be fixed","id":"5000000055051"},"contactId":"5000000017055","departmentId":"5000000012860","rating":"OKAY","threadId":"5000000092069","feedback":"The battery performance is better but I expect a little more.","accountId":"5000000017043","ratedTime":"2018-09-26T10:49:16.202Z","timezoneOffset":"GMT +5:30","contact":{"name":"Sam Rossner","id":"5000000017055"},"id":"5000000092084","ticketId":"5000000055051"}]}