Skip to main content
GET
Get a job

Authorizations

Authorization
string
header
required

OAuth 2.0 Client Credentials flow. The tokenUrl shown is for the production environment. For other environments, replace prod with the target environment name (e.g., auth.staging.oleria.io for staging).

Path Parameters

job_id
string
required

The job identifier returned by the execute endpoint.

Response

Job status and results. Check status to determine job state. When running or pending, poll again after retry_after seconds.

Status and results for a query job. A completed job carries statistics and, when the engine exposes a downloadable artifact, downloads. When status is failed, the error field describes the failure.

job_id
string
required

Unique identifier for the query job. Use this value to poll for status via the jobs endpoint.

status
enum<string>
required

Current job state. pending = queued, running = executing, completed = results available, failed = execution error.

Available options:
pending,
running,
completed,
failed
retry_after
integer

Recommended polling interval in seconds. Present when status is pending or running. Clients should wait at least this long before polling again.

Example:

5

downloads
object[]

Download references for the query result, present once status is completed and the engine exposes a downloadable artifact (omitted otherwise). A csv result is a single reference; a json result may be several references that together hold the complete result set.

download
object

Convenience reference to the single result file. Present only when the result is exactly one file — always so for csv — and identical to the sole downloads entry when present. A result delivered as multiple files populates only downloads, so a client that must handle any result should read downloads.

rows
object[]

An initial page of results, inline, so a client can render a preview without fetching the file. Present when status is completed. The complete result set is delivered via downloads when present.

statistics
object

Execution statistics. Reported when status is completed and the engine returns statistics for the execution; absent when none are available.

error
object

Error details when status is failed.