JavaScript
const response = await api.coding.getBatchJobStatus('123e4567-e89b-12d3-a456-426614174000');response = api.coding.get_batch_job_status('123e4567-e89b-12d3-a456-426614174000')curl --request GET \
--url https://surveys.getaftercare.com/api/v1/coding/{batchJobId} \
--header 'X-Aftercare-Key: <api-key>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://surveys.getaftercare.com/api/v1/coding/{batchJobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://surveys.getaftercare.com/api/v1/coding/{batchJobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Aftercare-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://surveys.getaftercare.com/api/v1/coding/{batchJobId}")
.header("X-Aftercare-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://surveys.getaftercare.com/api/v1/coding/{batchJobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Aftercare-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}
}{
"code": "INVALID_REQUEST",
"message": "Invalid batch job ID format"
}{
"code": "INVALID_API_KEY",
"message": "Invalid or missing API key"
}{
"code": "NOT_FOUND",
"message": "Batch job not found"
}{
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}{
"code": "GATEWAY_TIMEOUT",
"message": "The server took too long to respond"
}AI Coding
Get AI Coding Batch Job Results
Retrieves the current status and results of a batch coding job
GET
/
api
/
v1
/
coding
/
{batchJobId}
JavaScript
const response = await api.coding.getBatchJobStatus('123e4567-e89b-12d3-a456-426614174000');response = api.coding.get_batch_job_status('123e4567-e89b-12d3-a456-426614174000')curl --request GET \
--url https://surveys.getaftercare.com/api/v1/coding/{batchJobId} \
--header 'X-Aftercare-Key: <api-key>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://surveys.getaftercare.com/api/v1/coding/{batchJobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://surveys.getaftercare.com/api/v1/coding/{batchJobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Aftercare-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://surveys.getaftercare.com/api/v1/coding/{batchJobId}")
.header("X-Aftercare-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://surveys.getaftercare.com/api/v1/coding/{batchJobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Aftercare-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}
}{
"code": "INVALID_REQUEST",
"message": "Invalid batch job ID format"
}{
"code": "INVALID_API_KEY",
"message": "Invalid or missing API key"
}{
"code": "NOT_FOUND",
"message": "Batch job not found"
}{
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}{
"code": "GATEWAY_TIMEOUT",
"message": "The server took too long to respond"
}Authorizations
API key for authentication
Path Parameters
ID of the batch coding job to check
Response
Batch coding job status retrieved successfully
Unique identifier for the coding job
Example:
"123e4567-e89b-12d3-a456-426614174000"
Unique identifier for the survey
Example:
"CSAT-2024-Q1"
Status of the batch job that determines the structure of results
Available options:
queued, processing, completed, partial_failure, total_failure 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.
- Success Response
- Error Response
Show child attributes
Show child attributes
⌘I

