Skip to main content
POST
Get respondent results

Authorizations

api-key
string
header
required

Body

application/json

Request body for getting a respondent

surveyName
string
required

The name of the survery.

Example:

"Global Vacation Insights 2024"

respondentId
string
required

The unique identifier for a respondent, making it easy to distinguish them from others in the survey

Example:

"RESP497770"

Response

When a request is successfully processed, the API responds with a 200 OK status code and the expected data. The structure of the response varies based on the respondent's status.

This response mode is available when the respondent status is COMPLETED. In this case, the system returns the full quality assessment of the respondent.

success
enum<boolean>

A variable indicating whether the operation was successful.

Available options:
true,
false
message
string

A variable that human-readable message providing additional context or confirmation of the requested action.

results
object

This variable includes all quality parameters associated with a respondent.