Surveys

Surveys enable the operators and visitors to provide feedback and free-form comments about engagements.

get
Get Visitor Survey Answers

https://api.salemove.com/engagements/{engagement_id}/visitor_survey
Fetches the survey information provided by the visitor following an engagement. The user requesting the survey must have at least operator role on the site the survey belongs to.
Request
Response
Request
Path Parameters
engagement_id
required
string
ID of the engagement for which the survey answer is requested.
Headers
Authorization
required
string
Used to authenticate the user. Only Bearer access token is allowed.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/engagements/$engagement_id/visitor_survey"
Response
200: OK
{
"questions": [
{
"id": 796,
"type": "scale",
"title": "How would you rate this agency?",
"required": false
},
{
"id": 797,
"type": "scale",
"title": "How would you rate this operator?",
"required": false
},
{
"id": 798,
"type": "text",
"title": "Other Thoughts",
"required": false
}
],
"answers": [
{
"id": 796,
"response": 5
},
{
"id": 797,
"response": 4
},
{
"id": 798,
"response": "Wonderful! From now on, when I need assistance I'll just come online to find it."
}
]
}

get
Get Operator Survey Answers

https://api.salemove.com/engagements/{engagement_id}/operator_survey
Fetches the survey information provided by the operator following an engagement. The user requesting the survey must have at least operator role on the site the survey belongs to.
Request
Response
Request
Path Parameters
engagement_id
required
string
ID of the engagement for which the survey answer is requested.
Headers
Authorization
required
string
Used to authenticate the user. Only Bearer access token is allowed.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request GET \
--header "Authorization: Bearer $access_token" \
--header "Accept: application/vnd.salemove.v1+json" \
"https://api.salemove.com/engagements/$engagement_id/operator_survey"
Response
200: OK
{
"questions": [
{
"id": 1703,
"type": "boolean",
"title": "Did you set an appointment?",
"required": false
},
{
"id": 1704,
"type": "boolean",
"title": "Did you use CoBrowsing?",
"required": false
},
{
"id": 1705,
"type": "boolean",
"title": "Did you use Video/Audio",
"required": false
},
{
"id": 1706,
"type": "single_choice",
"title": "What was the use case for this Engagement?",
"required": true,
"choices": [
{
"id": 479,
"title": "Service"
},
{
"id": 480,
"title": "Sales"
}
]
}
],
"answers": [
{
"id": 1703,
"response": false
},
{
"id": 1704,
"response": true
},
{
"id": 1703,
"response": true
},
{
"id": 1703,
"response": 479
}
]
}

put
Update Visitor Survey Answers

https://api.salemove.com/engagements/{engagement_id}/visitor_survey/answers
Submits visitor survey response for the given engagement ID. The user updating a survey must have the role visitor on the site the survey belongs to.
Request
Response
Request
Path Parameters
engagement_id
required
string
ID of the engagement for which the survey answer is updated.
Headers
Authorization
required
string
Used to authenticate the user. Only Bearer access token is allowed.
Accept
required
string
Must be application/vnd.salemove.v1+json
curl --request PUT \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
--data-binary '{
"answers":[
{
"question_id":"796",
"response":"$response"
},
{
"question_id":"797",
"response":"$response"
},
{
"question_id":"798",
"response":"$response"
}
]
}'
"https://api.salemove.com/engagements/$engagement_id/visitor_survey/answers"
Response
200: OK
{
"success": true
}