Batch Jobs

Get batch job detail

Changed on

Retrieve a single batch job with its chunks and failures.

get/api/v1/batch-jobs/{batch_job_id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

batch_job_idstring MeteroidId required
Example:bjob_7n42DGM5Tflk9n8mt7Fhc7

Batch job ID

Response

Batch job detail

completed_atstring date-time nullable
created_atstring date-time required
created_bystring uuid required
error_csv_urlstring nullable
failed_itemsinteger required
failure_countinteger required
has_error_csvboolean required
idstring MeteroidId required
input_file_namestring nullable
input_file_urlstring nullable
job_type'EVENT_CSV_IMPORT' | 'CUSTOMER_CSV_IMPORT' | 'SUBSCRIPTION_CSV_IMPORT' | 'SUBSCRIPTION_PLAN_MIGRATION' required
processed_itemsinteger required
status'PENDING' | 'CHUNKING' | 'PROCESSING' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'FAILED' | 'CANCELLED' required
total_itemsinteger nullable

Example response

{
  "id": "bjob_7n42DGM5Tflk9n8mt7Fhc7"
}

Changes