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'
}]
});response = api.quality.evaluate(
survey_name='Customer Satisfaction',
survey_entries=[{
'question': 'How satisfied are you?',
'answer': 'I really love playing tennis with my friends on Fridays'
}]
)curl --request POST \
--url https://surveys.getaftercare.com/api/v1/data-quality \
--header 'Content-Type: application/json' \
--header 'X-Aftercare-Key: <api-key>' \
--data '
{
"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>"
}
],
"surveyName": "<string>",
"surveyDescription": "<string>",
"surveyIdentifier": "<string>",
"responseIdentifier": "<string>",
"aftercareResponseIdentifier": 123,
"qualityIssues": []
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://surveys.getaftercare.com/api/v1/data-quality",
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([
'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>'
]
],
'surveyName' => '<string>',
'surveyDescription' => '<string>',
'surveyIdentifier' => '<string>',
'responseIdentifier' => '<string>',
'aftercareResponseIdentifier' => 123,
'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"
payload := strings.NewReader("{\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 \"surveyName\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"responseIdentifier\": \"<string>\",\n \"aftercareResponseIdentifier\": 123,\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")
.header("X-Aftercare-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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 \"surveyName\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"responseIdentifier\": \"<string>\",\n \"aftercareResponseIdentifier\": 123,\n \"qualityIssues\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://surveys.getaftercare.com/api/v1/data-quality")
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 \"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 \"surveyName\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"responseIdentifier\": \"<string>\",\n \"aftercareResponseIdentifier\": 123,\n \"qualityIssues\": []\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"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"
}{
"code": "GATEWAY_TIMEOUT",
"message": "The request timed out"
}AI Data Quality Evaluation
Evaluate Data Quality
Evaluates the quality of survey responses for potential issues
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'
}]
});response = api.quality.evaluate(
survey_name='Customer Satisfaction',
survey_entries=[{
'question': 'How satisfied are you?',
'answer': 'I really love playing tennis with my friends on Fridays'
}]
)curl --request POST \
--url https://surveys.getaftercare.com/api/v1/data-quality \
--header 'Content-Type: application/json' \
--header 'X-Aftercare-Key: <api-key>' \
--data '
{
"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>"
}
],
"surveyName": "<string>",
"surveyDescription": "<string>",
"surveyIdentifier": "<string>",
"responseIdentifier": "<string>",
"aftercareResponseIdentifier": 123,
"qualityIssues": []
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://surveys.getaftercare.com/api/v1/data-quality",
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([
'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>'
]
],
'surveyName' => '<string>',
'surveyDescription' => '<string>',
'surveyIdentifier' => '<string>',
'responseIdentifier' => '<string>',
'aftercareResponseIdentifier' => 123,
'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"
payload := strings.NewReader("{\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 \"surveyName\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"responseIdentifier\": \"<string>\",\n \"aftercareResponseIdentifier\": 123,\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")
.header("X-Aftercare-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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 \"surveyName\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"responseIdentifier\": \"<string>\",\n \"aftercareResponseIdentifier\": 123,\n \"qualityIssues\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://surveys.getaftercare.com/api/v1/data-quality")
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 \"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 \"surveyName\": \"<string>\",\n \"surveyDescription\": \"<string>\",\n \"surveyIdentifier\": \"<string>\",\n \"responseIdentifier\": \"<string>\",\n \"aftercareResponseIdentifier\": 123,\n \"qualityIssues\": []\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"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"
}{
"code": "GATEWAY_TIMEOUT",
"message": "The request timed out"
}Authorizations
API key for authentication
Headers
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
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.
Show child attributes
Show child attributes
The name of the survey as it will appear in the Aftercare platform
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.)
Optional unique identifier for the survey.
Aftercare will use this to build a data model to associate questions and answers with the survey.
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.
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.
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 Response
Successfully evaluated survey quality
Number of quality issues detected across all survey entries
Required range:
x >= 0A score between 0 and 100 that represents the overall quality of the survey response. (Deprecated: use demeritScore instead)
Required range:
0 <= x <= 100A 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 <= 100Show child attributes
Show child attributes
Unique identifier for the survey response generated by Aftercare
If Aftercare has detected any quality issues for this response