Get a forecast job - Narrative I/O Knowledge Base

Get a forecast job

curl --request GET \
  --url https://api-dev.narrative.io/nql/{job_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-dev.narrative.io/nql/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-dev.narrative.io/nql/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.narrative.io/nql/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.narrative.io/nql/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "ef628399-1c83-44ff-8525-69c3796cfc7c",
  "company_id": 1,
  "completed_at": null,
  "created_at": "2025-04-11T23:37:40.796820Z",
  "failures": [],
  "idempotency_key": "9c987819-b5e9-4357-abe6-52c1e6a2e8b5",
  "input": {
    "nql": "EXPLAIN SELECT company_data.\"9561\".\"STATE\" FROM company_data.\"9561\"",
    "compiled_sql": "..."
  },
  "request_source": {
    "type": "api_user",
    "company_id": 1,
    "user_id": 1414
  },
  "result": null,
  "state": "running",
  "updated_at": "2025-04-11T23:37:41.168859Z"
}

GET

nql

{job_id}

Get a forecast job

curl --request GET \
  --url https://api-dev.narrative.io/nql/{job_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-dev.narrative.io/nql/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-dev.narrative.io/nql/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.narrative.io/nql/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.narrative.io/nql/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "ef628399-1c83-44ff-8525-69c3796cfc7c",
  "company_id": 1,
  "completed_at": null,
  "created_at": "2025-04-11T23:37:40.796820Z",
  "failures": [],
  "idempotency_key": "9c987819-b5e9-4357-abe6-52c1e6a2e8b5",
  "input": {
    "nql": "EXPLAIN SELECT company_data.\"9561\".\"STATE\" FROM company_data.\"9561\"",
    "compiled_sql": "..."
  },
  "request_source": {
    "type": "api_user",
    "company_id": 1,
    "user_id": 1414
  },
  "result": null,
  "state": "running",
  "updated_at": "2025-04-11T23:37:41.168859Z"
}

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

A forecast job, started by an EXPLAIN statement.

string<uuid>

required

Unique identifier for the job.

company_id

integer<int64>

required

Company that ran the job.

Example:

345

created_at

string<date-time>

required

The timestamp representing when the job was created.

failures

object[]

required

causes of job failure

Show child attributes

idempotency_key

string

required

The unique ID associated with the job.

request_source

object

required

Show child attributes

Example:

{
  "type": "api_user",
  "company_id": 1,
  "user_id": 1248
}

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 its compiled SQL as sent to the executor.

Show child attributes

completed_at

string<date-time> | null

When the job finished, or null while it is still pending or running.

result

object

The forecast once the job has completed, or the failure that ended it. Null while the job is pending or running.

Option 1
Option 2

Show child attributes