ATattentive
Bulk Status

Retrieve the status of a bulk ingestion job

Checks the status of a bulk ingestion job identified by bulkJobId. This endpoint returns the current state of the job (IN_PROGRESS, NEEDS_REVIEW, COMPLETED, or CANCELLED) along with the total record count and, once the job has completed successfully, a link to download the results.

If the job has completed successfully, the response includes a downloadable link to a .jsonl (JSON Lines) file containing a record of each request and its corresponding response. User's can audit results or process downstream outcomes of the bulk operation. You can fetch requests up to 2 weeks old.

Scopes Required: No Additional scopes required.

Default Rate Limit: 100 requests per second

get/v2/bulk/job/{bulkJobId}

Request

  • Base URL
    https://api.attentivemobile.com
  • Auth
    HTTP bearer

Path parameters

bulkJobIdstring required

id of the bulk job

Response

Returns the status of the bulk job

bulkJobIdstring

A unique identifier representing the submitted batch job. Use this ID to query the job's status, retrieve results, or diagnose any errors related to the job. This ID is returned upon successful job submission and required for all follow-up actions related to the batch.

statusstring

The current state of the batch job. Typical values are:

  • IN_PROGRESS – The job has been accepted and its records are being processed.

  • COMPLETED – The job finished successfully. The url field contains a link to download the results.

NEEDS_REVIEW and CANCELLED are rare but possible values.

totalRecordsinteger

The total number of records included in the batch job. This represents the full count of items submitted for processing, regardless of whether they ultimately succeeded or failed.

urlstring

A direct URL to download the results of the batch job, when available. This field is typically populated once the job has completed successfully. The file will contain per-record results in a JSON Lines (.jsonl) file.

Changes

No recorded changes to this operation across all 2 revisions of this API.