OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
GET/v1/calc/backfill/{job_id}

Read calculation backfill progress

operation ID: get_v1_calc_backfill_by_job_id

Overview

Read calculation backfill progress. The calculation API repairs historical derived data and explains how calculated values were produced.

When to use it

  • Use it when an application needs to read calculation backfill progress.
  • Use it when an engineer is validating derived data, diagnosing a rule, or repairing a historical calculation window.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

cURL

curl --request GET \
  --url "$ORDINATE_URL/v1/calc/backfill/00000000-0000-4000-8000-000000000001" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Backfill view

Example 200 output

{
  "job_id": "00000000-0000-4000-8000-000000000001",
  "state": "string",
  "progress": {
    "windows_total": 0,
    "windows_done": 0,
    "points_written": 0,
    "rate_limited_ms": 0
  },
  "preview": {
    "points_added": 0,
    "points_changed": 0,
    "points_unchanged": 0,
    "sample": [
      {
        "asset_id": "00000000-0000-4000-8000-000000000001",
        "ts_ns": 0,
        "old": {},
        "new": {}
      }
    ]
  }
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read calculation backfill progress. The documented 200 response is backfill view.

How it works

Backfills are managed jobs, while lineage, status, and trace reads expose the inputs and evaluation state behind calculated series.

Reference

Required capability
read
Authorization scope
held anywhere

Parameters

NameInRequiredType and constraints
job_idpathyes
stringformat: uuid

Request body

This operation has no request body.

Responses

200Backfill view

application/json

job_idstringrequired
format: uuid
previewany ofrequired

any of

option 1

points_addedintegerrequired
format: int64
points_changedintegerrequired
format: int64
points_unchangedintegerrequired
format: int64
samplearrayrequired

array

asset_idstringrequired
format: uuid
newany ofrequired

Arbitrary JSON value

any of

option 1

object with arbitrary properties

option 2

array

any items

option 3

string

option 4

number

option 5

integer

option 6

boolean

option 7

null
oldany ofrequired

any of

option 1

any of

option 1

object with arbitrary properties

option 2

array

any items

option 3

string

option 4

number

option 5

integer

option 6

boolean

option 7

null

option 2

null
ts_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
unknown fields rejected
unknown fields rejected

option 2

null
progressobjectrequired
unknown fields rejected
points_writtenintegerrequired
format: int64
rate_limited_msintegerrequired
format: int64
windows_doneintegerrequired
format: int64
windows_totalintegerrequired
format: int64
unknown fields rejected
statestringrequired
unknown fields rejected

Example 200 output

{
  "job_id": "00000000-0000-4000-8000-000000000001",
  "state": "string",
  "progress": {
    "windows_total": 0,
    "windows_done": 0,
    "points_written": 0,
    "rate_limited_ms": 0
  },
  "preview": {
    "points_added": 0,
    "points_changed": 0,
    "points_unchanged": 0,
    "sample": [
      {
        "asset_id": "00000000-0000-4000-8000-000000000001",
        "ts_ns": 0,
        "old": {},
        "new": {}
      }
    ]
  }
}
401Authentication required

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 401 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
403read capability is not granted

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 403 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
404Backfill not found

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 404 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
503Model database is not configured or unavailable

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 503 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

JavaScript

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/calc/backfill/00000000-0000-4000-8000-000000000001`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);

Related topics