Add Respondent
API endpoint for adding a new respondent with quality check data
Authorizations
Body
Request body for adding a new respondent
The unique identifier for a respondent, making it easy to distinguish them from others in the survey. The respondent ID can be freely chosen for flexibility.
💡 Important: The system utilizes this ID, combined with the survey name, to uniquely identify the respondent within a survey. This allows the same respondent ID to participate in multiple surveys without conflicts.
If the combination of survey name and respondent ID already exists, an error will be displayed.
🔦 Tip: You can use the same respondent ID as in the survey tool to easily identify the respondent later.
"RESP497770"
The name of the survery, which helps identify different surveys. The survey name can be assigned freely.
💡Important: If the survey name already exists, the system will add the respondent under the appropriate survey. If the survey name is new, a new survey will be created, and the respondent will be added to the new survey.
⭕ Note: Each survey identifier must be unique for a given user.
🔦 Tip: you can simply make survey name unique by adding a timestamp.
As Example: Global Vacation Insights - 1709040600
An array of data points used for quality checks on each respondent. For the Coherence Score (CHS), only a single data point is allowed, which must contain the entire interview.
🧪 Validations:
- A maximum of 10
OES
data points are allowed per respondent. - A maximum of 100
TS
data points are allowed per respondent. - A maximum of 20
GQS
data points are allowed per respondent. - A maximum of 1 with 1000 question/answer pairs
CHS
data point is allowed per respondent.
Exceeding these limits will trigger validation errors. Ensure that the number of data points per respondent remains within the allowed limits.
An array of data points used to perform quality checks on each respondent.
Indicates whether cleaning should be applied to the respondent.
💡Important: To remove bad respondents automatically, ensure this variable is set to true.
When cleaning is enabled, the response will include the variable isExcluded, which indicates whether the respondent has been excluded based on the applied criteria.
true
Cleaning settings define the rules for determining whether a respondent should be excluded and marked as low quality. If a respondent’s scores fall below the threshold, they will be excluded and flagged as low quality.
💡Important: If no custom cleaning settings are defined and cleaning is enabled, the system will apply ReDem’s recommended cleaning settings. You can view the recommended settings here: ReDem Recommended Cleaning Settings
For more details on how cleaning works, refer to the Data Cleaning section.
Indicates whether the response should be processed synchronously.
- Set to
true
if you need an immediate response. - Set to false if you don’t need to wait; you can later check the respondent’s status using the Get Respondent Status endpoint.
true
Response
Synchronous Response
This response mode is triggered when synchronousResponse
is set to true
.
In this mode, the system generates a detailed response containing all quality parameters of the respondent. The request will wait (await
) until the full response is ready before proceeding.
A variable indicating whether the operation was successful.
A variable that human-readable message providing additional context or confirmation of the requested action.
This variable includes all quality parameters associated with a respondent.
Synchronous Response
This response mode is triggered when synchronousResponse
is set to true
.
In this mode, the system generates a detailed response containing all quality parameters of the respondent. The request will wait (await
) until the full response is ready before proceeding.
A variable indicating whether the operation was successful.
A variable that human-readable message providing additional context or confirmation of the requested action.
This variable includes all quality parameters associated with a respondent.
Asynchronous Response
This response mode is triggered when synchronousResponse
is set to false
.
In this case, the system generates a detailed response and processes it asynchronously, meaning the request will not wait (await
) for the evaluation to complete. Instead, the evaluation is performed in the background, and the status of the respondent can be retrieved later using the Get Respondent Status endpoint.
A variable indicating whether the operation was successful.
A variable that human-readable message providing additional context or confirmation of the requested action.
This variable includes all quality parameters associated with a respondent.