POST
/
api
/
v1
/
data-quality
/
batch
const response = await api.quality.evaluateBatch({
  surveyName: 'Customer Satisfaction',
  responses: [{
    responseIdentifier: '54321',
    surveyEntries: [{
        question: 'How satisfied are you?',
        answer: 'I really love playing tennis with my friends on Fridays'
    }]
  }],
  callbackUrl: 'https://example.com/callback'
});
{
  "batchJobId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "queued",
  "results": {
    "items": [],
    "nextCursor": null
  }
}

Authorizations

​
X-Aftercare-Key
string
header
required

API key for authentication

Body

application/json
​
surveyName
string
required

The name of the survey

​
responses
object[]
required
​
callbackUrl
string
required

URL where results should be sent when processing completes

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

​
surveyDescription
string

A description of the survey purpose and background.

​
qualityIssues
enum<string>[]

Types of quality issues that can be detected in survey responses.

  • Nonsensical - Response lacks logical meaning or sense. Likely gibberish.
  • Irrelevant - Response does not address the question.
  • Low Effort - Respondent did not put in much effort to answer the question. Lacks detail or concrete examples.
  • LLM Generated - Response appears to be generated by AI.
  • Self Duplicated - Responses from the same respondent contain duplicated content across multiple answers. Only evaluated when multiple survey entries are provided or if a survey identifier and response identifier is provided.
  • Shared Duplicate - Responses contain duplicated content across different respondents for the same question. Only evaluated if survey identifiers and question identifiers are provided.
Available options:
Nonsensical,
Irrelevant,
Low Effort,
LLM Generated,
Repeated Answers,
Duplicate Answers

Response

202
application/json
Batch evaluation job accepted
​
batchJobId
string
required

Unique identifier for the batch processing job

​
status
enum<string>
required

Status values for batch processing jobs

Available options:
queued,
processing,
completed,
failed
​
results
object
Evaluate Data QualityGet Data Quality Batch Job Status