Submit a rating against a named survey
curl --request POST \
--url https://{host}/api/public/feedback/projects/{projectId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"survey": "<string>",
"rating": 123,
"session_id": "<string>",
"comment": "<string>",
"externalUserId": "<string>",
"channel": "<string>",
"response_source": "external",
"message_id": "<string>"
}
'{
"success": true,
"data": {
"response_id": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Submit rating for survey
Submit a rating against a named survey
POST
/
api
/
public
/
feedback
/
projects
/
{projectId}
Submit a rating against a named survey
curl --request POST \
--url https://{host}/api/public/feedback/projects/{projectId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"survey": "<string>",
"rating": 123,
"session_id": "<string>",
"comment": "<string>",
"externalUserId": "<string>",
"channel": "<string>",
"response_source": "external",
"message_id": "<string>"
}
'{
"success": true,
"data": {
"response_id": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Records one rating for the survey named in the body. The rating is validated against the survey’s control range (thumbs 0-1, star 1-5, scale 0-10). The rating is rejected rather than clamped when out of range, so a fabricated value can never reach the score. The response counts toward the survey’s headline figure by default, scored by the survey’s own method exactly as a runtime-captured response is. It requires the
feedback-survey:write permission.Body
application/json
Was this page helpful?