JavaScript
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'
});response = api.quality.evaluateBatch(
survey_name='Customer Satisfaction',
responses=[{
responseIdentifier: '54321',
'surveyEntries': [{
'question': 'How satisfied are you?',
'answer': 'I really love playing tennis with my friends on Fridays'
}]
}],
callback_url='https://example.com/callback'
)curl --request POST \
--url https://surveys.getaftercare.com/api/v1/data-quality/batch \
--header 'Content-Type: application/json' \
--header 'X-Aftercare-Key: <api-key>' \
--data '
{
"surveyName": "<string>",
"responses": [
{
"surveyEntries": [
{
"question": "<string>",
"answer": "<string>",
"questionContext": "<string>",
"questionIdentifier": "<string>",
"parentQuestionIdentifier": "<string>",
"keyEvents": [
{
"k": "<string>",
"t": 123,
"ht": 123,
"c": "<string>"
}
],
"pasteEvents": [
{
"t": 123,
"c": "<string>"
}
],
"honeypotPhrase": "<string>"
}
],
"responseIdentifier": "<string>"
}
],
"callbackUrl": "<string>",
"surveyIdentifier": "<string>",
"surveyDescription": "<string>",
"qualityIssues": []
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://surveys.getaftercare.com/api/v1/data-quality/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'surveyName' => '<string>',
'responses' => [
[
'surveyEntries' => [
[
'question' => '<string>',
'answer' => '<string>',
'questionContext' => '<string>',
'questionIdentifier' => '<string>',
'parentQuestionIdentifier' => '<string>',
'keyEvents' => [
[
'k' => '<string>',
't' => 123,
'ht' => 123,
'c' => '<string>'
]
],
'pasteEvents' => [
[
't' => 123,
'c' => '<string>'
]
],
'honeypotPhrase' => '<string>'
]
],
'responseIdentifier' => '<string>'
]
],
'callbackUrl' => '<string>',
'surveyIdentifier' => '<string>',
'surveyDescription' => '<string>',
'qualityIssues' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Aftercare-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://surveys.getaftercare.com/api/v1/data-quality/batch"
payload := strings.NewReader("{\n \"surveyName\": \"<string>\",\n \"responses\": [\n {\n \"surveyEntries\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\",\n \"questionContext\": \"<string>\",\n \"questionIdentifier\": \"<string>\",\n \"parentQuestionIdentifier\": \"<string>\",\n \"keyEvents\": [\n {\n \"k\": \"<string>\",\n \"t\": 123,\n \"ht\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"pasteEvents\": [\n {\n \"t\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"honeypotPhrase\": \"<string>\"\n }\n ],\n \"responseIdentifier\": \"<string>\"\n }\n ],\n \"callbackUrl\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"qualityIssues\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Aftercare-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://surveys.getaftercare.com/api/v1/data-quality/batch")
.header("X-Aftercare-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"surveyName\": \"<string>\",\n \"responses\": [\n {\n \"surveyEntries\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\",\n \"questionContext\": \"<string>\",\n \"questionIdentifier\": \"<string>\",\n \"parentQuestionIdentifier\": \"<string>\",\n \"keyEvents\": [\n {\n \"k\": \"<string>\",\n \"t\": 123,\n \"ht\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"pasteEvents\": [\n {\n \"t\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"honeypotPhrase\": \"<string>\"\n }\n ],\n \"responseIdentifier\": \"<string>\"\n }\n ],\n \"callbackUrl\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"qualityIssues\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://surveys.getaftercare.com/api/v1/data-quality/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Aftercare-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"surveyName\": \"<string>\",\n \"responses\": [\n {\n \"surveyEntries\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\",\n \"questionContext\": \"<string>\",\n \"questionIdentifier\": \"<string>\",\n \"parentQuestionIdentifier\": \"<string>\",\n \"keyEvents\": [\n {\n \"k\": \"<string>\",\n \"t\": 123,\n \"ht\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"pasteEvents\": [\n {\n \"t\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"honeypotPhrase\": \"<string>\"\n }\n ],\n \"responseIdentifier\": \"<string>\"\n }\n ],\n \"callbackUrl\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"qualityIssues\": []\n}"
response = http.request(request)
puts response.read_body{
"batchJobId": "123e4567-e89b-12d3-a456-426614174000",
"status": "queued",
"results": {
"items": [],
"nextCursor": null
}
}{
"code": "INVALID_REQUEST",
"message": "Invalid request parameters",
"details": {
"question": "Question is required"
}
}{
"code": "INVALID_API_KEY",
"message": "Invalid or missing API key"
}{
"code": "NOT_FOUND",
"message": "Requested resource not found"
}{
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}AI Data Quality Evaluation
Evaluate Data Quality Batch
Asynchronously evaluates the quality of multiple survey responses
POST
/
api
/
v1
/
data-quality
/
batch
JavaScript
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'
});response = api.quality.evaluateBatch(
survey_name='Customer Satisfaction',
responses=[{
responseIdentifier: '54321',
'surveyEntries': [{
'question': 'How satisfied are you?',
'answer': 'I really love playing tennis with my friends on Fridays'
}]
}],
callback_url='https://example.com/callback'
)curl --request POST \
--url https://surveys.getaftercare.com/api/v1/data-quality/batch \
--header 'Content-Type: application/json' \
--header 'X-Aftercare-Key: <api-key>' \
--data '
{
"surveyName": "<string>",
"responses": [
{
"surveyEntries": [
{
"question": "<string>",
"answer": "<string>",
"questionContext": "<string>",
"questionIdentifier": "<string>",
"parentQuestionIdentifier": "<string>",
"keyEvents": [
{
"k": "<string>",
"t": 123,
"ht": 123,
"c": "<string>"
}
],
"pasteEvents": [
{
"t": 123,
"c": "<string>"
}
],
"honeypotPhrase": "<string>"
}
],
"responseIdentifier": "<string>"
}
],
"callbackUrl": "<string>",
"surveyIdentifier": "<string>",
"surveyDescription": "<string>",
"qualityIssues": []
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://surveys.getaftercare.com/api/v1/data-quality/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'surveyName' => '<string>',
'responses' => [
[
'surveyEntries' => [
[
'question' => '<string>',
'answer' => '<string>',
'questionContext' => '<string>',
'questionIdentifier' => '<string>',
'parentQuestionIdentifier' => '<string>',
'keyEvents' => [
[
'k' => '<string>',
't' => 123,
'ht' => 123,
'c' => '<string>'
]
],
'pasteEvents' => [
[
't' => 123,
'c' => '<string>'
]
],
'honeypotPhrase' => '<string>'
]
],
'responseIdentifier' => '<string>'
]
],
'callbackUrl' => '<string>',
'surveyIdentifier' => '<string>',
'surveyDescription' => '<string>',
'qualityIssues' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Aftercare-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://surveys.getaftercare.com/api/v1/data-quality/batch"
payload := strings.NewReader("{\n \"surveyName\": \"<string>\",\n \"responses\": [\n {\n \"surveyEntries\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\",\n \"questionContext\": \"<string>\",\n \"questionIdentifier\": \"<string>\",\n \"parentQuestionIdentifier\": \"<string>\",\n \"keyEvents\": [\n {\n \"k\": \"<string>\",\n \"t\": 123,\n \"ht\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"pasteEvents\": [\n {\n \"t\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"honeypotPhrase\": \"<string>\"\n }\n ],\n \"responseIdentifier\": \"<string>\"\n }\n ],\n \"callbackUrl\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"qualityIssues\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Aftercare-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://surveys.getaftercare.com/api/v1/data-quality/batch")
.header("X-Aftercare-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"surveyName\": \"<string>\",\n \"responses\": [\n {\n \"surveyEntries\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\",\n \"questionContext\": \"<string>\",\n \"questionIdentifier\": \"<string>\",\n \"parentQuestionIdentifier\": \"<string>\",\n \"keyEvents\": [\n {\n \"k\": \"<string>\",\n \"t\": 123,\n \"ht\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"pasteEvents\": [\n {\n \"t\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"honeypotPhrase\": \"<string>\"\n }\n ],\n \"responseIdentifier\": \"<string>\"\n }\n ],\n \"callbackUrl\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"qualityIssues\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://surveys.getaftercare.com/api/v1/data-quality/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Aftercare-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"surveyName\": \"<string>\",\n \"responses\": [\n {\n \"surveyEntries\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\",\n \"questionContext\": \"<string>\",\n \"questionIdentifier\": \"<string>\",\n \"parentQuestionIdentifier\": \"<string>\",\n \"keyEvents\": [\n {\n \"k\": \"<string>\",\n \"t\": 123,\n \"ht\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"pasteEvents\": [\n {\n \"t\": 123,\n \"c\": \"<string>\"\n }\n ],\n \"honeypotPhrase\": \"<string>\"\n }\n ],\n \"responseIdentifier\": \"<string>\"\n }\n ],\n \"callbackUrl\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"qualityIssues\": []\n}"
response = http.request(request)
puts response.read_body{
"batchJobId": "123e4567-e89b-12d3-a456-426614174000",
"status": "queued",
"results": {
"items": [],
"nextCursor": null
}
}{
"code": "INVALID_REQUEST",
"message": "Invalid request parameters",
"details": {
"question": "Question is required"
}
}{
"code": "INVALID_API_KEY",
"message": "Invalid or missing API key"
}{
"code": "NOT_FOUND",
"message": "Requested resource not found"
}{
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}Authorizations
API key for authentication
Body
application/json
The name of the survey
Show child attributes
Show child attributes
URL where results should be sent when processing completes
Optional unique identifier for the survey.
Aftercare will use this to build a data model to associate questions and answers with the survey.
A description of the survey purpose and background.
Optional array of specific quality issues to evaluate. If not provided, all applicable quality issues will be checked.
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 The mode in which Aftercare will evaluate the quality of the survey responses.
Responsiveness- Checks for poor responsesAuthenticity- Checks for fraudulent responsesComposite- Checks for all quality issues
If both a detectionMode and qualityIssues are provided, Aftercare will use the detection mode.
Available options:
Responsiveness, Authenticity, Composite