Skip to main content
POST
/
v2
/
getRespondent
Get respondent results
curl --request POST \
  --url https://api.redem.io/v2/getRespondent \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "surveyName": "Global Vacation Insights 2024",
  "respondentId": "RESP497770"
}'
{
  "success": true,
  "message": "Respondent quality successfully retrieved",
  "results": {
    "respondentId": "RESP497770",
    "status": "COMPLETED",
    "respondentQuality": {
      "isExcluded": true,
      "reasonsForExclusion": [
        "Open Ended Score Threshold",
        "Coherence Score Threshold"
      ],
      "redemScore": 85,
      "qualityScoreSummary": [
        {
          "qualityCheck": "OES",
          "score": 80
        },
        {
          "qualityCheck": "CHS",
          "score": 75,
          "reason": "The user shows several inconsistencies and contradictions, such as different ..."
        },
        {
          "qualityCheck": "GQS",
          "score": 85
        },
        {
          "qualityCheck": "TS",
          "score": 70
        },
        {
          "qualityCheck": "BAS",
          "score": 75
        }
      ],
      "dataPointsSummary": [
        {
          "qualityCheck": "OES",
          "dataPointId": "Q1",
          "score": 85,
          "category": "VALID_ANSWER"
        },
        {
          "qualityCheck": "TS",
          "dataPointId": "durationQ1",
          "score": 95
        },
        {
          "qualityCheck": "GQS",
          "dataPointId": "Q2",
          "score": 90
        },
        {
          "qualityCheck": "OES",
          "dataPointId": "Q3",
          "score": 75,
          "category": "VALID_ANSWER"
        },
        {
          "qualityCheck": "TS",
          "dataPointId": "durationQ3",
          "score": 50
        },
        {
          "qualityCheck": "CHS",
          "dataPointId": "CHS_Question",
          "score": 75,
          "reason": "The user shows several inconsistencies and contradictions, such as different ..."
        },
        {
          "qualityCheck": "GQS",
          "dataPointId": "Q4",
          "score": 80
        },
        {
          "qualityCheck": "TS",
          "dataPointId": "totalDuration",
          "score": 65
        },
        {
          "qualityCheck": "BAS",
          "dataPointId": "interactionsQ1",
          "score": 75,
          "category": "NATURAL_TYPING"
        }
      ]
    }
  }
}

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.

  • Respondet Completed
  • Respondent Processing

This response mode available when respondent status is COMPLETED.

In this case, the system generates a comprehensive, quality assessment of the respondent.

​
success
boolean

A variable indicating whether the operation was successful.

​
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.