Skip to main content
POST
/
api
/
v1
/
data-quality
JavaScript
const response = await api.quality.evaluate({
  surveyName: 'Customer Satisfaction',
  surveyEntries: [{
    question: 'How satisfied are you?',
    answer: 'I really love playing tennis with my friends on Fridays'
  }]
});
{
  "numIssues": 1,
  "qualityScore": 30,
  "demeritScore": 70,
  "evaluations": [
    {
      "surveyEntry": {
        "question": "How satisfied were you with our service?",
        "answer": "I really love playing tennis with my friends on Fridays"
      },
      "numIssues": 1,
      "qualityScore": 30,
      "demeritScore": 70,
      "qualityIssueChecks": [
        {
          "type": "Irrelevant",
          "score": 10,
          "isIssue": true
        },
        {
          "type": "Nonsensical",
          "score": 80,
          "isIssue": true
        },
        {
          "type": "Incomplete",
          "score": 60,
          "isIssue": false
        },
        {
          "type": "Low Effort",
          "score": 95,
          "isIssue": true
        },
        {
          "type": "LLM Generated",
          "score": 80,
          "isIssue": false
        },
        {
          "type": "Self Duplicated",
          "score": 30,
          "isIssue": false
        },
        {
          "type": "Shared Duplicate",
          "score": 30,
          "isIssue": false
        }
      ]
    }
  ],
  "aftercareResponseIdentifier": 12345
}

Authorizations

​
X-Aftercare-Key
string
header
required

API key for authentication

Headers

​
X-Request-Encoding
enum<string>
default:unicode

Specifies the encoding format of the request data. Use html if you are sending data that HTML entity encodes non-ASCII characters.

Available options:
unicode,
html

Body

application/json
​
surveyEntries
object[]
required

The collection of question-answer pairs to evaluate.

If a respondent does not answer a question, DO NOT include that question in the surveyEntries array.

​
surveyName
string

The name of the survey as it will appear in the Aftercare platform

​
surveyDescription
string

A description of the survey purpose and background.

It will be used to give the AI more context around specific aspects of the survey (e.g. brand/product names, movie names, etc.)

​
surveyIdentifier
string

Optional unique identifier for the survey.

Aftercare will use this to build a data model to associate questions and answers with the survey.

​
responseIdentifier
string

Optional unique identifier for a respondent's entire response to a survey.

Aftercare will use this to build a data model tie together questions and answer pairs for a single response.

​
aftercareResponseIdentifier
number

Optional unique identifier for the survey response. If not provided, Aftercare will generate one.

This identifier is useful for tracking survey responses that are submitted in multiple parts or over time.

If both a responseIdentifier and aftercareResponseIdentifier are provided, Aftercare will use the aftercareResponseIdentifier.

​
qualityIssues
enum<string>[]

Optional array of specific quality issues to evaluate. If not provided, all applicable quality issues will be checked.

​
detectionMode
enum<string>

The mode in which Aftercare will evaluate the quality of the survey responses.

  • Responsiveness - Checks for poor responses
  • Authenticity - Checks for fraudulent responses
  • Composite - Checks for all quality issues

If both a detectionMode and qualityIssues are provided, Aftercare will use the detection mode.

Available options:
Responsiveness,
Authenticity,
Composite

Response

Successfully evaluated survey quality

​
numIssues
integer
required

Number of quality issues detected across all survey entries

Required range: x >= 0
​
qualityScore
number
required

A score between 0 and 100 that represents the overall quality of the survey response. (Deprecated: use demeritScore instead)

Required range: 0 <= x <= 100
​
demeritScore
number
required

A score between 0 and 100 that represents the overall quality of the survey response.

The score is an average of the quality scores across all survey entries.

The higher the score, the greater the likelihood and severity of data quality issues.

Required range: 0 <= x <= 100
​
evaluations
object[]
required
​
aftercareResponseIdentifier
number
required

Unique identifier for the survey response generated by Aftercare

​
hasIssues
boolean

If Aftercare has detected any quality issues for this response