AI Coding
Get AI Coding Batch Job Results
Retrieves the current status and results of a batch coding job
GET
/
api
/
v1
/
coding
/
{batchJobId}
Copy
const response = await api.coding.getBatchJobStatus('123e4567-e89b-12d3-a456-426614174000');
Copy
{
"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
API key for authentication
Path Parameters
ID of the batch coding job to check
Response
200
application/json
Batch coding job status retrieved successfully
The response is of type object
.
Copy
const response = await api.coding.getBatchJobStatus('123e4567-e89b-12d3-a456-426614174000');
Copy
{
"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
}
}
Assistant
Responses are generated using AI and may contain mistakes.