Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Returns the survey results of the services specified.

Status
colourYellow
titleHTTP POST
/livechat/:domain/getSurveyResultsByServiceID

Path Variables:

Name

Mandatory

Type

Description

domain

Status
titleNO

Status
titleSTRING

Unique domain identifier

Authorization: see Authentication mechanisms

Request Body:

Type:
Status
titleJSON

Name

Mandatory

Type

Description

serviceIdList

Status
colourRed
titleYES

Status
titleARRAY

Array of service IDs

lt

Status
titleNO

Status
titleNUMBER

Epoch Unix Timestamp before (read <) which chats are searched for (based on the beginTime field). At least one between lt an gt must be present in order to limit the research.

gt

Status
titleNO

Status
titleNUMBER

Epoch Unix Timestamp after (read >) which chats are searched for (based on the beginTime field). At least one between lt an gt must be present in order to limit the research.

Response:

Type:
Status
titleJSON

Name

Type

Description

result

Status
titleBOOLEAN

If true, the service response was performed correctly

error

Status
titleNULL
/
Status
titleSTRING

Contains the error description if an error has occurred in the request

surveyResults

Status
titleARRAY

Array of objects containing the survey results of the services requested

Example:

Request

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

Request body

Code Block
languagejson
{
    "lt": 1714119031667,
    "gt": 1709039127067,
    "serviceIdList" : ["LiveChat_Popup", "5550633690"]
}
Code Block
languagejson
{
    "lt": 1714119031667,
    "serviceIdList" : ["LiveChat_Popup", "5550633690"]
}
Code Block
languagejson
{
    "gt": 1709039127067,
    "serviceIdList" : ["LiveChat_Popup", "5550633690"]
}

...