Skip to main content
GET
Get the result of a NQL forecast

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

job_id
string<uuid>
required

Unique identifier for a job.

Response

OK

id
string<uuid>
required

Unique identifier for the job.

company_id
string<uuid>
required

Company that ran the job.

completed_at
string<date-time>
required

The timestamp representing when the job finished.

created_at
string<date-time>
required

The timestamp representing when the job was created.

failures
object[]
required

causes of job failure

idempotency_key
string
required

The unique ID associated with the job.

request_source
object
required
Example:
state
enum<string>
default:pending
required
Available options:
failed,
cancelled,
completed,
pending,
scheduled,
pending_cancellation,
running
updated_at
string<date-time>
required

The timestamp representing when the job was updated.

input
object
required

The query and it's compiled sql sent to the executor.

result
object