List feedback comments
GET {{baseUrl}}/api/v1/articleFeedbacks
This API lists a particular number of comments received on an article, based on the limit defined.
OAuth Scope
Desk.articles.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | Index number, starting from which the comments must be fetched. Default value is 1. | |
limit | string | Number of comments to list. Default value is 10. | |
sortBy | string | Key that sorts the comments based on a specific attribute: createdTime. To sort the comments in descending order, append a '-' before the value. | |
include | string | Additional information related to the comments. Values allowed are: ticket, contact and resolution. | |
departmentIds | string | Filter article feedback comments based on department ids | |
rootCategoryIds | string | Filter article feedback comments based on rootCategoryIds | |
timeRange | string | Key that filters comments created within a specific date and time range. Enter the time limit in the formats of <br>LAST_24_HRS,<br> <br>LAST_7_DAYS,<br> <br>LAST_30_DAYS,<br> <br>LAST_365_DAYS<br> and <br>yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ<br>. Default value : LAST_7_DAYS. | |
locale | string | Locale of an article translation in which feedback comments to be fetched |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"ticket":{"ticketNumber":"163","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/b34f0de640d72a1d8d1a6f7ca800abb8f3148ec5bcd90913","id":"22372000001389007","deletedTime":"2018-10-07T10:27:20.000Z","deletedBy":{"photoURL":"https://desk.zoho.com/api/v1/agent/22372000000761001/photo","name":"Zylker","id":"22372000000761001","status":"ACTIVE","zuid":"15223452"}},"contactId":"22372000001386025","contact":{"photoURL":null,"name":"John","id":"22372000001386025"},"createdTime":"2018-10-07T15:55:24.000Z","id":"22372000001386045","resolution":{"modifiedTime":"2020-12-03T05:08:21.000Z","createdBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/22372000000000063/photo?orgId=15224553","name":"Charlie","id":"22372000000000063","status":"ACTIVE","zuid":"15224552"},"feedbackId":"227800000075038","createdTime":"2020-12-03T05:08:21.000Z","modifiedBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/22372000000000063/photo?orgId=15224553","name":"Charlie","id":"22372000000000063","status":"ACTIVE","zuid":"15224552"},"id":"22372340000106009","resolution":"Content has been modified in user basis","contentType":"PLAIN_TEXT"},"ticketId":"22372000001389007","content":"Please add pricing details in tabular columns","article":{"author":{"photoURL":"https://desk.zoho.com/api/v1/agents/22372000000000063/photo?orgId=15224553","name":"Charlie","id":"22372000000000063","status":"ACTIVE","zuid":"15224552"},"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/22372000001370011","id":"22372000001370011","locale":"en","title":"Pricing details"},"status":"RESOLVED"}]}