OCocrolus
Cash Flow Analytics

Async job status

Retrieves the status and result of an analytics job created when any supported analytics endpoint is called with async=true. Poll this endpoint until the job reaches a terminal state (DONE or FAILED).

The job status moves through the following states: PENDING while the job is running, DONE when the result is ready, and FAILED if the job could not be completed. Poll every few seconds until a terminal state is reached. Large Books may take longer to process.

When the status is DONE, the response includes a result_url, a temporary pre-signed download link to retrieve the analytics payload, which is identical in shape to the corresponding synchronous endpoint's response. The job and its result_url are valid for 24 hours from the time the job was created.

get/v2/analytics/jobs/{job_id}

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v2/analytics/jobs/{job_id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Path parameters

job_idstring uuid required

The job ID returned in the 202 response when the async request was submitted.

Response

The job is complete. Fetch the result_url to download the analytics payload. The URL expires 24 hours after the job was created.

job_idstring uuid

The unique identifier of the async job.

status'DONE'

The job completed successfully.

result_urlstring uri

A temporary pre-signed link to download the analytics payload. Expires 24 hours after the job was created.

Example response

{
  "job_id": "0f2b9c3a-9d1e-4c1a-9d2e-2c9a1b3c4d5e",
  "status": "DONE",
  "result_url": "https://.../async_jobs/0f2b9c3a...?X-Amz-Signature=..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.