Sign in

v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Batch

Get Helix Batch Job Status

Returns status of Helix batch job.

get/v2/batch/jobs/{job_id}

Path parameters

job_idstring required

Response

OK

completed_atstring

ISO 8601 timestamp when job completed (only in final response)

created_atstring required

ISO 8601 timestamp when job was created

error_messagestring

Error message if the job failed at the job level

failed_itemsinteger

Number of items that failed

failure_file_urlstring

Pre-signed S3 URL to download failure details (if any failures)

job_idstring required

Unique identifier for the batch job

processed_itemsinteger

Number of items processed so far

statusstring required

Current status: pending, processing, completed, or failed

successful_itemsinteger

Number of items successfully processed (only in final response)

total_itemsinteger required

Total number of items in the batch

updated_atstring

ISO 8601 timestamp of last progress update

Example response

{
  "completed_at": "2025-12-05T10:05:00Z",
  "created_at": "2025-12-05T10:00:00Z",
  "failed_items": 3,
  "failure_file_url": "https://s3.amazonaws.com/bucket/batch/failures/550e8400.json?signature=...",
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "processed_items": 100,
  "progress_percent": 100,
  "status": "completed",
  "successful_items": 97,
  "total_items": 100
}