getSurveyResultsByChatID

Returns the survey results of the chats specified.

HTTP POST /livechat/:domain/getSurveyResultsByChatID

Path Variables:

Name	Mandatory	Type	Description

Name	Mandatory	Type	Description
domain	NO	STRING	Unique domain identifier

Authorization: see Authentication mechanisms

Request Body:

Type: JSON

Name	Mandatory	Type	Description

Name	Mandatory	Type	Description
chatIdList	YES	Array	Array of chat IDs

Response:

Type: JSON

Name	Type	Description

Name	Type	Description
result	BOOLEAN	If true, the service response was performed correctly
error	NULL / STRING	Contains the error description if an error has occurred in the request
surveyResults	array	Array of objects containing the survey results of the chats requested

Example:

Request

http://<hostname>:<port>/livechat/default/getSurveyResultsByChatID

Request body

{
    "chatIdList" : ["CHAT_DEFAULT_fc8a0cde-2155-4a8e-8ef4-8e71ca76c43e", "CHAT_DEFAULT_1e3383ec-917e-44ac-a4d9-d7ac4724a71c", "CHAT_DEFAULT_510fd551-94ee-49fb-93f9-20ce013003b0"]
}

Response

{
    "result": true,
    "surveyResults": [
        {
            "id": "survey-web-star",
            "title": {
                "it-it": "Survey",
                "en-gb": "Survey"
            },
            "dc_mode": "survey_chat",
            "datacollection": [
                {
                    "dc_type": "rating_star",
                    "label": "Dai un voto alla conversazione avvenuta!",
                    "isMandatory": false,
                    "isVisibleAgent": false,
                    "isVisibleCustomer": true,
                    "isEditable": true,
                    "custom_regexp": "",
                    "customMandatoryErrorMessage": "",
                    "customValidationErrorMessage": "",
                    "value": "3",
                    "name": "survey_chat",
                    "mode": "manual",
                    "min": 0,
                    "max": 5,
                    "step": 1
                }
            ],
            "contactInfo": {
                "chatID": "CHAT_DEFAULT_510fd551-94ee-49fb-93f9-20ce013003b0",
                "servid": "LiveChat_Popup",
                "widgetid": "classic_popup",
                "beginTime": 1714118317897,
                "endTime": 1714118338964
            }
        },
        {
            "id": "survey-web-star",
            "title": {
                "it-it": "Survey",
                "en-gb": "Survey"
            },
            "dc_mode": "survey_chat",
            "datacollection": [
                {
                    "dc_type": "rating_star",
                    "label": "Dai un voto alla conversazione avvenuta!",
                    "isMandatory": false,
                    "isVisibleAgent": false,
                    "isVisibleCustomer": true,
                    "isEditable": true,
                    "custom_regexp": "",
                    "customMandatoryErrorMessage": "",
                    "customValidationErrorMessage": "",
                    "value": "4",
                    "name": "survey_chat",
                    "mode": "manual",
                    "min": 0,
                    "max": 5,
                    "step": 1
                }
            ],
            "contactInfo": {
                "chatID": "CHAT_DEFAULT_fc8a0cde-2155-4a8e-8ef4-8e71ca76c43e",
                "servid": "LiveChat_Popup",
                "widgetid": "classic_popup",
                "beginTime": 1712149307715,
                "endTime": 1712149338859
            }
        }
    ],
    "error": null
}

CTLive

getSurveyResultsByChatID

Analytics

HTTP POST /livechat/:domain/getSurveyResultsByChatID

Path Variables:

Request Body:

Type: JSON

Response:

Type: JSON

Example:

Request

Request body

Response

Related content