Surveys

Surveys

Surveys enable operators and visitors to provide feedback about engagements. A survey can be composed of one or more questions of the following types: free-text, scale, yes/no and single choice.

post
Create Survey

https://api.salemove.com/sites/{site_id}/surveys
Create a survey for a given site. The user creating a survey must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the survey is created.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
Body Parameters
name
required
string
Survey name.
description
required
string
Survey description.
title
required
string
Survey title.
type
required
string
The type of the survey. Supported values are visitor and operator.
is_default
required
boolean
If true, the survey will be shown by default. Can only be set to true when is_enabled is true also.
is_enabled
required
boolean
If true, the survey can be used if it is either default or there exists a matching queue_id.
queue_ids
required
array
Queue IDs to which the survey is attached. If the survey is set as default, then the parameter queue_ids must be null.
questions
required
array
Ordered array of question UUIDs that are attached to the given survey.
curl --request POST \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
--data-binary '{
"name": "Engagement Survey",
"description": "Engagement survey description",
"title": "Please rate the experience.",
"type": "visitor",
"is_default": true,
"is_enabled": true,
"queue_ids": null,
"questions": [
{
"id": "9e801cb2-9fc7-4003-9f2d-43c24d03df8f",
"required": true
},
{
"id": "c12897f2-a816-4a94-ad3a-4243c1a3c95e",
"required": false
}
]
}' \
"https://api.salemove.com/sites/$site_id/surveys"
Response
200: OK
{
"id": "e544d4fb-3a28-4f39-8b5d-c910a6c31c57",
"name": "Engagement Survey",
"description": "Engagement rating survey description",
"title": "Please rate the experience.",
"type": "visitor",
"is_default": true,
"is_enabled": true,
"queue_ids": null,
"questions": [
{
"id": "9e801cb2-9fc7-4003-9f2d-43c24d03df8f",
"required": true,
"position": 0
},
{
"id": "c12897f2-a816-4a94-ad3a-4243c1a3c95e",
"required": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee"
}

patch
Update Survey

https://api.salemove.com/sites/{site_id}/surveys/{survey_id}
Update a survey for a given site. The user who wants to update the survey must have at least manager role on the site the survey belongs to.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site the survey to be updated belongs to.
survey_id
required
string
ID of the survey to update.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
Body Parameters
name
optional
string
Survey name.
description
optional
string
Survey description.
title
optional
string
Survey title.
type
optional
string
The type of the survey. Supported values are visitor and operator.
is_default
optional
boolean
If true, the survey will be shown by default. Can only be set to true when is_enabled is true also.
is_enabled
optional
boolean
If true, the survey can be used if it is either default or there exists a matching queue_id.
queue_ids
optional
array
Queue IDs to which the survey is attached. If the survey is set as default, then the parameter queue_ids must be null.
questions
optional
array
Ordered array of question UUIDs that are attached to the given survey.
curl --request PATCH \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
--data-binary '{
"description": "Engagement survey description",
"title": "Please rate the experence.",
"type": "visitor",
"is_default": true,
"is_enabled": true,
"queue_ids": null,
"questions": [
{
"id": "9e801cb2-9fc7-4003-9f2d-43c24d03df8f",
"required": true,
"position": 0
},
{
"id": "c12897f2-a816-4a94-ad3a-4243c1a3c95e",
"required": false,
"position": 1
}
]
}' \
"https://api.salemove.com/sites/$site_id/surveys/$survey_id"
Response
200: OK
{
"id": "e544d4fb-3a28-4f39-8b5d-c910a6c31c57",
"name": "Engagement Survey",
"description": "Update engagement survey description",
"title": "Please rate the experence.",
"type": "visitor",
"is_default": true,
"is_enabled": true,
"queue_ids": null,
"questions": [
{
"id": "9e801cb2-9fc7-4003-9f2d-43c24d03df8f",
"required": true,
"position": 0
},
{
"id": "c12897f2-a816-4a94-ad3a-4243c1a3c95e",
"required": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee"
}

get
Survey List

https://api.salemove.com/sites/{site_id}/surveys
Get the list of surveys from a given site. The user getting a survey list must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the surveys are requested.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/sites/$site_id/surveys"
Response
200: OK
[
{
"id": "e544d4fb-3a28-4f39-8b5d-c910a6c31c57",
"name": "Engagement Survey",
"description": "Engagement rating survey description",
"title": "Please rate the experence.",
"type": "visitor",
"is_default": true,
"is_enabled": true,
"queue_ids": null,
"questions": [
{
"id": "9e801cb2-9fc7-4003-9f2d-43c24d03df8f",
"name": "Question One name",
"text": "Question One",
"type": "boolean",
"site_id": "a415188d-d571-420a-a115-af990936c40f",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"created_at": "2020-02-20T00:00:00Z",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_at": "2020-02-20T00:00:00Z",
"required": true,
"position": 0
},
{
"id": "c12897f2-a816-4a94-ad3a-4243c1a3c95e",
"name": "Question Two name",
"text": "Question Two",
"type": "boolean",
"site_id": "a415188d-d571-420a-a115-af990936c40f",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"created_at": "2020-02-20T00:00:00Z",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_at": "2020-02-20T00:00:00Z",
"required": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee"
},
{
"id": "e544d4fb-3a28-4f39-8b5d-c910a6c31c57",
"name": "Engagement Survey",
"description": "Engagement rating survey description",
"title": "Please rate the experence.",
"type": "operator",
"is_default": true,
"is_enabled": true,
"queue_ids": null,
"questions": [
{
"id": "9e801cb2-9fc7-4003-9f2d-43c24d03df8f",
"name": "Question One name",
"text": "Question One",
"type": "boolean",
"site_id": "a415188d-d571-420a-a115-af990936c40f",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"created_at": "2020-02-20T00:00:00Z",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_at": "2020-02-20T00:00:00Z",
"required": true,
"position": 0
},
{
"id": "c12897f2-a816-4a94-ad3a-4243c1a3c95e",
"name": "Question Two name",
"text": "Question Two",
"type": "boolean",
"site_id": "a415188d-d571-420a-a115-af990936c40f",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"created_at": "2020-02-20T00:00:00Z",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_at": "2020-02-20T00:00:00Z",
"required": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee"
},
...
]

get
Survey

https://api.salemove.com/sites/{site_id}/surveys/{survey_id}
Get a specific survey from a given site. The user requesting a survey must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the survey is requested.
survey_id
required
string
ID of the requested survey.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/sites/$site_id/surveys/$survey_id"
Response
200: OK
{
"id": "e544d4fb-3a28-4f39-8b5d-c910a6c31c57",
"name": "Engagement Survey",
"description": "Engagement rating survey description",
"title": "Please rate the experence.",
"type": "visitor",
"is_default": true,
"is_enabled": true,
"queue_ids": null,
"questions": [
{
"id": "9e801cb2-9fc7-4003-9f2d-43c24d03df8f",
"required": true,
"position": 0
},
{
"id": "c12897f2-a816-4a94-ad3a-4243c1a3c95e",
"required": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee"
}

get
Engagement Survey

https://api.salemove.com/engagements/{engagement_id}/survey
Fetches a survey for given engagement for the requester's user type. If requesting user's role is operator, the surveys with type operator is returned. If requesting user's role is visitor, the survey with type visitor is returned.
Request
Response
Request
Path Parameters
engagement_id
required
string
ID of the engagement for which the survey is requested.
Headers
Authorization
required
string
The bearer access token to authenticate the user.
Accept
required
string
Must be application/vnd.salemove.v1+json.
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/engagements/$engagement_id/survey"
Response
200: OK
Response is a survey information containing questions and their options that needs to be answered by visitor or operator.
{
"survey": {
"id": "f47be834-6627-4723-b4df-9c727b711b0e",
"name": "Test Operator Survey Name",
"description": "Test Operator Survey Description",
"title": "Test Operator Survey Title",
"type": "operator",
"questions": [
{
"id": "5f6bd3c4-5a6f-4d9f-ae17-a3bab34837ba",
"name": "Question One name.",
"text": "Question One is boolean.",
"type": "boolean",
"site_id": "9433e936-2e61-436a-9d42-7decc9184686",
"created_by": "5e0c3871-f35e-4d4c-aa86-7bb05597f675",
"created_at": "2020-02-12T12:44:17.916Z",
"updated_by": "5e0c3871-f35e-4d4c-aa86-7bb05597f675",
"updated_at": "2020-02-12T12:44:17.916Z",
"required": true,
"position": 0
},
{
"id": "0e55cad8-2bb0-4cdf-820a-5722bb61b611",
"name": "Question Two name.",
"text": "Question Two is just text?",
"type": "text",
"site_id": "9433e936-2e61-436a-9d42-7decc9184686",
"created_by": "5e0c3871-f35e-4d4c-aa86-7bb05597f675",
"created_at": "2020-02-12T12:44:17.918Z",
"updated_by": "5e0c3871-f35e-4d4c-aa86-7bb05597f675",
"updated_at": "2020-02-12T12:44:17.918Z",
"required": true,
"position": 1
},
{
"id": "7e513cd7-f0a9-400e-b2ce-4ba574494864",
"name": "Question Three name.",
"text": "Question Three has options.",
"type": "single_choice",
"site_id": "01c2556f-5a02-4d62-a492-7328568f0217",
"created_by": "307e5e98-633a-478d-a02f-f8460d3dcc17",
"created_at": "2020-02-12T12:44:17.918Z",
"updated_by": "307e5e98-633a-478d-a02f-f8460d3dcc17",
"updated_at": "2020-02-12T12:44:17.918Z",
"required": true,
"position": 2,
"options": [
{
"id": "5260d5dc-cfc2-4e69-be04-d5a2ae9c20dd",
"label": "Option one",
"position": 0,
"is_default": true
},
{
"id": "263b5ecd-6184-4c09-8b53-6f78906a2b29",
"label": "Option two",
"position": 1,
"is_default": false
}
]
}
]
}
}

delete
Survey

https://api.salemove.com/sites/{site_id}/surveys/{survey_id}
Delete a specific survey for a given site. The user deleting a survey must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the survey is deleted.
survey_id
required
string
ID of the survey to delete.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request DELETE \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/sites/$site_id/surveys/$survey_id"
Response
200: OK

post
Create Question

https://api.salemove.com/sites/{site_id}/survey_questions
Create a survey question for a given site. The user creating a survey question must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the question is created.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
Body Parameters
name
optional
string
Descriptive name.
text
optional
string
Question text.
type
optional
string
Type of the question. Supported values are text, scale, single_choice, boolean.
options
required
string
Mandatory only when type is single_choice.
curl --request POST \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
--data-binary '{
"name": "Question name",
"text": "Which one do you prefer?",
"type": "single_choice",
"options": [
{
"label": "Option one",
"is_default": true,
"position": 0
},
{
"label": "Option two",
"is_default": false,
"position": 1
}
]
}' \
"https://api.salemove.com/sites/$site_id/survey_questions"
Response
200: OK
{
"id": "27eeb947-0df9-4a1f-ba6c-58770c1c89fb",
"name": "Question name",
"text": "Which one do you prefer?",
"type": "single_choice",
"options": [
{
"label": "Option one",
"is_default": true,
"position": 0
},
{
"label": "Option two",
"is_default": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee"
}

patch
Update Question

https://api.salemove.com/sites/{site_id}/survey_questions/{question_id}
Update a survey question for a given site. The user updating a survey question must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the question is updated.
question_id
required
string
ID of the question to update.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
Body Parameters
name
optional
string
Descriptive name.
text
optional
string
Question text.
type
optional
string
Type of the question. Supported values are text, scale, single_choice, boolean.
options
required
string
Mandatory only when type is single_choice.
curl --request PATCH \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
--data-binary '{
"name": "Question name",
"text": "Which one do you prefer?",
"type": "single_choice",
"options": [
{
"label": "Option one",
"is_default": true,
"position": 0
},
{
"label": "Option two",
"is_default": false,
"position": 1
}
]
}' \
"https://api.salemove.com/sites/$site_id/survey_questions/$question_id"
Response
200: OK
{
"id": "27eeb947-0df9-4a1f-ba6c-58770c1c89fb",
"name": "Question name",
"text": "Which one do you prefer?",
"type": "single_choice",
"options": [
{
"label": "Option one",
"is_default": true,
"position": 0
},
{
"label": "Option two",
"is_default": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee"
}

get
Question List

https://api.salemove.com/sites/{site_id}/survey_questions
Get a list of survey questions for a given site. The user requesting the list of survey questions must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the questions are requested.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/sites/$site_id/survey_questions"
Response
200: OK
[
{
"id": "27eeb947-0df9-4a1f-ba6c-58770c1c89fb",
"name": "Quesrtion name",
"text": "Which one do you like more?",
"type": "single_choice",
"options": [
{
"label": "Option one",
"is_default": true,
"position": 0
},
{
"label": "Option two",
"is_default": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"attached_surveys": [
{
"id": "d0e21ca6-4394-47c4-a958-fa04100d5566",
"name": "Survey name"
}
]
},
{
...
}
]

get
Question

https://api.salemove.com/sites/{site_id}/survey_questions/{question_id}
Get a specific question for a given site. The user requesting a survey question must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the question is requested.
question_id
required
string
ID of the question.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/sites/$site_id/survey_questions/$question_id"
Response
200: OK
{
"id": "27eeb947-0df9-4a1f-ba6c-58770c1c89fb",
"name": "Some name",
"text": "Which one do you like more?",
"type": "single_choice",
"options": [
{
"label": "Option one",
"default": true,
"position": 0
},
{
"label": "Option two",
"default": false,
"position": 1
}
],
"created_at": "2020-02-20T00:00:00Z",
"updated_at": "2020-02-20T00:00:00Z",
"created_by": "e4ed3193-8719-4b6c-9885-8af699db87ee",
"updated_by": "e4ed3193-8719-4b6c-9885-8af699db87ee"
}

delete
Question

https://api.salemove.com/sites/{site_id}/survey_questions/{question_id}
Delete a specific question for a given site. The user deleting a survey question must have at least manager role on the given site.
Request
Response
Request
Path Parameters
site_id
required
string
ID of the site for which the question is deleted.
question_id
required
string
ID of the question to delete.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request DELETE \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/sites/$site_id/survey_questions/$question_id"
Response
200: OK

post
Create Answers

https://api.salemove.com/surveys/{survey_id}/answers
Creates answers for a survey in the context of a given engagement. The user submitting answers to the survey must be participant (visitor or operator) of the given engagement.
Request
Response
Request
Path Parameters
survey_id
required
string
ID of the survey for which the answers are created.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json.
Body Parameters
engagement_id
required
string
ID of the engagement for which the answers are created.
answers
required
array
List of answers to create. Each answer must consist of question_id and response.
curl --request POST \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
--data-binary '{
"engagement_id": "650c8da5-0bb5-42e4-8b99-4a28b1b71535",
"answers": [
{
"question_id": "cffd17b6-ec5c-459b-909b-73bc31f05804",
"response": "free-text response"
},
{
"question_id": "f999fb61-32f5-42cf-8619-c2e2b72fbcec",
"response": 5
},
{
"question_id": "04d399ad-eb48-4261-8c14-28ce9f3022ed",
"response": false
}
]
}' \
"https://api.salemove.com/surveys/$survey_id/answers"
Response
200: OK
{
"success": true
}

get
Visitor Answers

https://api.salemove.com/engagements/{engagement_id}/survey_answers/visitor
Get the visitor's survey answers. The user getting the answers must be either an operator who participated in the engagement or a user who has at least manager role on the given site.
Request
Response
Request
Path Parameters
engagement_id
required
string
ID of the engagement for which the visitor's answers are requested.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/engagements/$engagement_id/survey_answers/visitor"
Response
200: OK
{
"answers": [
{
"id": "c0955f77-d451-4c33-a393-df916124c74b",
"question_id": "c1732287-9d63-4173-9213-bd3de3d336c8",
"title": "How satisfied are you with the customer service?",
"position": 0,
"type": "scale",
"answer": 5
},
{
"id": "6811db44-d356-402a-b40d-1a734eec5450",
"question_id": "740cf9ff-01bc-435e-819d-c153df1d4b1b",
"title": "Do you have any extra feedback?",
"position": 1,
"type": "text",
"answer": "I got answers to all my questions."
},
{
"id": "2a2e995e-930c-4bf5-b722-aa51163ae93e",
"question_id": "5723d10d-f868-465d-a92d-0c49b7a3f4d8",
"title": "What was the chat topic?",
"position": 2,
"type": "single_choice",
"answer": "Payment"
},
{
"id": "35985944-c708-44c9-9afe-910a9b361208",
"question_id": "5d533134-05e2-4db3-afc4-a518bb5c36e7",
"title": "Would you use the customer service again?",
"position": 3,
"type": "boolean",
"answer": true
}
]
}

get
Operator Answers

https://api.salemove.com/engagements/{engagement_id}/survey_answers/operator
Get the operator's survey answers. The user getting the answers must be either an operator who participated in the engagement or a user who has at least manager role on the given site.
Request
Response
Request
Path Parameters
engagement_id
required
string
ID of the engagement for which the operator's answers are requested.
Headers
Authorization
required
string
The bearer access token to authorize the user.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/engagements/$engagement_id/survey_answers/operator"
Response
200: OK
{
"answers": [
{
"id": "c0955f77-d451-4c33-a393-df916124c74b",
"question_id": "c1732287-9d63-4173-9213-bd3de3d336c8",
"title": "How satisfied are you with the customer service?",
"position": 0,
"type": "scale",
"answer": 5
},
{
"id": "6811db44-d356-402a-b40d-1a734eec5450",
"question_id": "740cf9ff-01bc-435e-819d-c153df1d4b1b",
"title": "Do you have any extra feedback?",
"position": 1,
"type": "text",
"answer": "I got answers to all my questions."
},
{
"id": "2a2e995e-930c-4bf5-b722-aa51163ae93e",
"question_id": "5723d10d-f868-465d-a92d-0c49b7a3f4d8",
"title": "What was the chat topic?",
"position": 2,
"type": "single_choice",
"answer": "Payment"
},
{
"id": "35985944-c708-44c9-9afe-910a9b361208",
"question_id": "5d533134-05e2-4db3-afc4-a518bb5c36e7",
"title": "Would you use the customer service again?",
"position": 3,
"type": "boolean",
"answer": true
}
]
}

Question Types

Type

Description

text

Free text question. The visitor or the operator can express in their own words the engagement experience.

scale

Numerical scale question. The visitor or the operator can evaluate, on a predefined scale, the engagement experience with the grade from 1 to 5 (1 being the worst, 5 being the best).

single_choice

The visitor or the operator can select and option from a predefined set.

boolean

Yes/No question. The visitor or the operator can agree or disagree with the question statement.

Question Type single_choice

If the survey type is single_choice the request body has to have an object element with the following parameters:

Parameter

Required

Type

Description

label

Yes

String

Descriptive label for the choice.

is_default

Yes

Boolean

Default choice, can be applied to only one choice. This will be the question's answer if the respondent will ignore the question.

position

Yes

Number

Position within the list of choices. Counting starts from 0.