API Change Log

​

New Endpoint: Retry Respondents

• POST /v3/retryRespondents - Retry specific quality checks for a list of respondents within a survey.

​

API v3 Released: OES v3 with Enhanced Category Detection and Effort Scale

​

🔥 OES v3 Now Available in ReDem API v3

​

🚀 What’s new in OES v3?

• VALID_ANSWER: Responses that adequately address the question
• NO_ANSWER: Responses that provide no meaningful information
• BAD_LANGUAGE: Responses containing inappropriate or offensive language
• GIBBERISH: Responses that are nonsensical or incoherent
• OFF_TOPIC: Responses that do not address the question asked
• AI_SUSPECT: Responses that appear to be AI-generated
• WRONG_LANGUAGE: Responses in an unexpected language
• DUPLICATE_ANSWER: Responses that duplicate previous answers
• DUPLICATE_RESPONDENT: Responses that duplicate other respondents’ answers

​

Key improvements in OES v3:

• Clearer category boundaries: Refined detection logic reduces false positives and false negatives across all categories, providing more accurate quality assessments.
• Enhanced scoring system: OES v3 introduces an effort scale (LOW, MEDIUM, HIGH) that factors into the final quality score. For VALID_ANSWER and NO_ANSWER categories, the effort level directly influences the score calculation, providing more nuanced quality metrics.

​

🔄 Backward Compatibility: How do v1 and v2 work?

​

⛔ Deprecation Notice

• API v1: Will be deprecated within 7 days of this notice. Please migrate to v2 or v3 immediately.
• API v2: Will be deprecated on January 15th, 2026. We strongly encourage all teams and integrators to migrate to v3 endpoints before that date to take advantage of the improved OES accuracy and scoring system.

​

New Endpoint: Update Respondents Excluded Status

• POST /v2/updateRespondentsExcludedStatus - Update the exclusion status of one or more respondents within a specific survey.

​

New Endpoints: Delete Surveys and Delete Respondents

• POST /v2/deleteRespondents - Delete one or more respondents from a survey and clean up related data.
• POST /v2/deleteSurveys - Delete one or more surveys and all associated data.

​

API v2 Released: Consistent CHS Question IDs Supported

​

🔥 New Versioning Layer Introduced Across the ReDem API

​

🚀 What’s new in v2?

{ 
  "questionId": "Q1"
  "question": "What type of accommodation did you stay in?", 
  "answer": "Hotel",
}

• Consistent identifiers across all respondents
• Clear mapping between survey questions and CHS results

​

🔄 Backward Compatibility: How does v1 work?

• The system auto-generates questionIds like Q1, Q2, etc. uniquely for each respondent, making cross-respondent comparisons unreliable.

​

⛔ Deprecation Notice: API v1

​

API endpoint updates

  "redemScore": 60,
  "OES": {
    "activate": true,
    "score": 60,
    "minDataPoints":2,
    "categories": {
      "GENERIC_ANSWER": {"activate": true, "minDataPoints":2},
      "NO_INFORMATION": {"activate": true, "minDataPoints":3},
      // ... other categories ...
    }
  },
  "CHS": {"activate": true,"score": 50},
  "GQS": {"activate": true,"score": 40, "minDataPoints":2},
  "TS": {"activate": true,"score": 20},
  "BAS": {
    "activate": true,
    "score": 60, 
    "minDataPoints":2,
    "categories": {
      "UNNATURAL_TYPING": {"activate": true, "minDataPoints":2},
      "COPY_AND_PASTE": {"activate": true, "minDataPoints":2},
    }
  }

​

API endpoint updates

• The interactionData field within dataPoints → qualityCheck: BAS has been modified to support additional interaction types. Now, it has been expanded to include both KEYSTROKE and COPY_AND_PASTE interactions, enhancing tracking capabilities.
• Enhanced the request body cleaning settings by allowing activate/deactivate options for each quality check and enhanced cleaning settings by introducing Behavioral Analytics Score (BAS) along with its categories.
• Renamed the Fake Answer category in Open-Ended Score (OES) to AI-Generated Answer.
• We have enhanced the response structure by adding a field to retrieve Behavioral Analytics Score (BAS) results.

• Previously with GET request we pass the surveyName and respondentId as a path parameters. Now we pass it in the request body.

• Previously with GET request we pass the surveyName as a path parameter. Now we pass it in the request body.

• Previously with GET request we pass the surveyName as a path parameter. Now we pass it in the request body.

• Introduced a new variable, BASDataPoints, to specify the number of BAS data points required for credit calculation when evaluating a respondent.
• Rename the variable CHSInterviews to CHSAnswers in the request body.
• We have introduced a new response structure for the POST /creditCalculation endpoint, improving clarity by renaming several fields for better self-explanatory representation.

​

Enhanced the quality checks by introducing Behavioral Analytics Score (BAS)

• Removed the Copy-Paste category from Open-Ended Score (OES) and incorporated it under Behavioral Analytics Score (BAS).

​

Streamlined the API response in error cases

​

ReDem 3.0 API - Initial Release

​

🎉 Key Endpoints

• POST /respondent/add - Add a respondent to a survey.
• GET /respondent/getRespondent - Get a respondent’s details.
• GET /respondent/getAllRespondents - Get all respondents for a survey.
• GET /survey/stop - Stop a survey.
• GET /respondent/estimation - Get a respondent’s estimation.