Create AI Coding Batch Job

POST

api

coding

const response = await api.coding.createBatchJob({
  surveyIdentifier: 'CSAT-2024-Q1',
  surveyName: 'Customer Satisfaction',
  surveyDescription: 'Tracking customer satisfaction and loyalty',
  surveyResponses: [{
    questionIdentifier: 'Q1',
    question: 'What did you like about our service?',
    responseEntries: [{
      responseIdentifier: '12345',
      answer: 'The customer service representatives were very helpful.'
    }]
  }]
});

{
  "batchJobId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyIdentifier": "CSAT-2024-Q1",
  "status": "queued",
  "results": null
}

Authorizations

X-Aftercare-Key

string

header

required

API key for authentication

Body

application/json

surveyIdentifier

string

required

Unique string to identify the survey.

Example:

"CSAT-2024-Q1"

surveyResponses

object[]

required

Full collection of survey responses by question.

surveyResponses.questionIdentifier

string

required

Unique identifier for the question.

Example:

"Q1"

surveyResponses.question

string

required

The question that was asked.

Example:

"What did you like about our service?"

surveyResponses.responseEntries

object[]

required

The collection of answers for this question to code.

surveyResponses.questionContext

string

Optional context describing what the surveyor is attempting to learn from the respondent.

Example:

"I want to understand what aspects of our customer experience are working well."

surveyResponses.codingOptions

object

surveyResponses.codingOptions.maxLevels

integer

The maximum number of levels of categorization allowed. For example, if you only want codes and subcodes, set maxLevels to 2. Default: 2

Required range: x >= 1

Example:

3

surveyResponses.codingOptions.maxCodesPerLevel

The maximum number of codes to create at each level of the hierarchy. If you provide a single number, the same max will be applied to all levels. If you provide an array, the number of codes allowed at each level will be the value at that index. Default: 8

Required range: x >= 1

Example:

[8, 5, 3]

surveyResponses.codingOptions.minResponsesPerCode

integer

The minimum number of responses that must be present to form a new code. Default: 1

Required range: x >= 1

Example:

2

surveyName

string

Optional name for the survey. This is used to identify the survey in the Aftercare platform.

Example:

"Customer Satisfaction"

surveyDescription

string

An optional description of the survey's purpose, used to help the AI understand the context behind thesurvey better.

Example:

"Quarterly survey tracking customer satisfaction and loyalty for the XYZ Company which sells xyz products"

Response

202

application/json

Batch coding job accepted

batchJobId

string

required

Unique identifier for the coding job

Example:

"123e4567-e89b-12d3-a456-426614174000"

surveyIdentifier

string

required

Unique identifier for the survey

Example:

"CSAT-2024-Q1"

status

enum<string>

required

Status of the batch job that determines the structure of results

Available options:

queued,

processing,

completed,

partial_failure,

total_failure

results

object

The results structure depends on the status value. If the job is successful, the results will be a list of question codes with a hierarchical tree of codes and subcodes. If the job fails, the results will be the error details.

results.completedAt

string

required

When the batch job completed processing

Example:

"2024-03-12T15:30:45Z"

results.questionCodes

object[]

required

Coding results organized by question identifier. Each question will have its own hierarchical category tree.

results.nextCursor

string | null

Cursor for the next page of results. Null if there are no more results.

Example:

null

Get Data Quality Batch Job Status Get AI Coding Batch Job Results

const response = await api.coding.createBatchJob({
  surveyIdentifier: 'CSAT-2024-Q1',
  surveyName: 'Customer Satisfaction',
  surveyDescription: 'Tracking customer satisfaction and loyalty',
  surveyResponses: [{
    questionIdentifier: 'Q1',
    question: 'What did you like about our service?',
    responseEntries: [{
      responseIdentifier: '12345',
      answer: 'The customer service representatives were very helpful.'
    }]
  }]
});

{
  "batchJobId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyIdentifier": "CSAT-2024-Q1",
  "status": "queued",
  "results": null
}

API Documentation

AI Followup Generation

AI Data Quality Evaluation

AI Coding

Create AI Coding Batch Job

Authorizations

Body

Response