POST
/
api
/
v1
/
data-quality
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

Response

200
application/json

Successfully evaluated survey quality

The response is of type object.