Skip to main content

Job Status Parameters

Attribute

Description

Type

status

Current status of the job, includes pending, started, done, and failed.

String

job_id

System-generated unique identifier for the asynchronous enrichment change job.

String

start_time

Unix epoch time in seconds when the job started.

Integer

end_time

Unix epoch time in seconds when the job completed.

Integer

Asynchronous upload

Because it is a potentially long-running action, the table upload is performed asynchronously. Therefore, the immediate response indicates only whether the request was properly formatted and, if it was, provides a URL for checking the status of the upload.

The entire table upload must complete successfully for the changes to take effect; the API does not support partial success.

A typical asynchronous upload negotiation consists of these steps:

  1. Upload the table: A Job object is created and a location URL for checking the status is returned.

  2. Use the URL to periodically check the job status until it is set to done or failed.

  3. If the job was not successful, you can retry the request. If necessary, debug any connectivity issues or data formatting issues that may have contributed to the failed upload. For example, ensure the CSV file follows the enrichment schema definition.

Sample Object

{
  "status": "done",
  "job_id": "c750243a-39dd-4666-bf0c-f8715e19eb96_1662894455_indexcsv",
  "start_time": 1662894455,
  "end_time": 1662894462
}