Get the List of Feedbacks

Description

You can use this API to fetch the list of feedback from the website visitors.

HTTP Method - GET

Query Parameters

  • operator_ids: To fetch the feedback based on the ArrayList of the operator IDs
  • department_ids: To fetch the feedback based on the ArrayList of the department IDs
  • conversation_ids: To fetch the feedback based on the ArrayList of the conversation IDs
  • app_ids: To fetch the feedback based on the ArrayList of the app IDs
  • start_time: The feedback after the specified time will be retrieved and displayed.
  • end_time: The feedback before the specified time will be retrieved and displayed.
  • tag_ids: To fetch the feedback based on the tag.
  • tag_status: To fetch feedback on untagged chat/threads (Allowed value: "untagged").
  • timezone_offset: The time zone mentioned in the portal, you should define the offset for the time zone.
  • visitor_email: Based on the visitor's email address.
  • index: As the feedback list is limited to 20 per fetch, you can use this param to fetch the next set of feedbacks.
  • limit: The amount of feedback you would like to receive (The default limit is 20)
  • ratings: To fetch the ratings given by the visitor ("happy | neutral | sad")
  • list_by: To fetch feedback based on the thread/conversation (Allowed value: thread | conversation).
  • sort_order - (Optional) Specifies the sort order. Use "asc" for ascending or "desc" for descending.

OAuth Scope

SalesIQ.feedbacks.READ

URL:

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screen_name}/feedbacks

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylker/feedbacks

Payload

Copied{
  "index": "1"
  "limit": "30"
  "sort_order": "asc"
  "list_by": "thread"
  "operator_ids": "426628000007200007","426628000000074001"
  "department_ids" : "588399388405","588399388403"
  "conversation_ids": "114884007489407","114884007489488"
  "tag_status": "untagged"
  "app_ids": "426628000000002043"
  "ratings": "neutral"
  "start_time": "1703961000000"
  "end_time": "1746124199999"
}

Sample response

Copied{
    "url": "/api/v2/zylker/feedbacks",
    "object": "feedback_list",
    "data": [
        {
            "feedback": "Good",
            "id": "426628000007806003",
            "attender": {
                "email": "james@zylker.com",
                "display_name": "James",
                "type": "operator",
                "image_url": "/web/v2/zylker/downloads/1600875983595_426628000000074001?purpose=operator_image",
                "id": "426628000000074001"
            },
            "rating": {
                "type": "smiley",
                "value": "neutral"
            },
            "chatlet_count": "0",
            "visitor": {
                "last_name": "13801",
                "name": "Visitor 13801",
                "first_name": "Visitor",
                "supported_operations": [],
                "salutation": "None"
            },
            "conversation": {
                "question": "I want track my recent order.",
                "end_time": "1705562877614",
                "start_time": "1705562863566",
                "reference_id": "6762",
                "notes_available": "false",
                "mode": "call",
                "id": "426628000007804003"
            },
            "app_id": "426628000000002043",
            "thread_id": "0",
            "created_time": "1705562895926",
            "department_id": "426628000000002013"
        }
    ],
    "more_data_available": false
}