GET
/
api
/
v1
/
coding
/
{batchJobId}
const response = await api.coding.getBatchJobStatus('123e4567-e89b-12d3-a456-426614174000');
{
  "batchJobId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyIdentifier": "CSAT-2024-Q1",
  "status": "completed",
  "results": {
    "completedAt": "2024-03-12T15:30:45Z",
    "questionCodes": [
      {
        "questionIdentifier": "Q1",
        "question": "What did you like about our service?",
        "responseCodes": [
          {
            "id": 1,
            "label": "Customer Service Quality",
            "responses": [
              {
                "responseIdentifier": "12345",
                "answer": "The customer service representatives were very helpful and resolved my issue quickly."
              }
            ],
            "subCodes": [
              {
                "id": 11,
                "label": "Staff Helpfulness",
                "responses": [
                  {
                    "responseIdentifier": "12345",
                    "answer": "The customer service representatives were very helpful and resolved my issue quickly."
                  }
                ],
                "subCodes": []
              }
            ]
          },
          {
            "id": 2,
            "label": "Delivery",
            "responses": [
              {
                "responseIdentifier": "12346",
                "answer": "I liked the easy-to-use website and fast delivery."
              }
            ],
            "subCodes": []
          }
        ]
      }
    ],
    "nextCursor": null
  }
}

Authorizations

​
X-Aftercare-Key
string
header
required

API key for authentication

Path Parameters

​
batchJobId
string
required

ID of the batch coding job to check

Response

200
application/json
Batch coding job status retrieved successfully
​
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.