Read calculation evaluation trace

Overview

Read calculation evaluation trace. 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 evaluation trace.
• 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 --request GET \
  --url "$ORDINATE_URL/v1/calc/rules/00000000-0000-4000-8000-000000000001/trace?asset_id=00000000-0000-4000-8000-000000000001&start_ns=0&end_ns=0" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "evaluations": [
    {
      "asset_id": "00000000-0000-4000-8000-000000000001",
      "output_series": "00000000-0000-4000-8000-000000000001",
      "window": {
        "start_ns": 0,
        "end_ns": 0
      },
      "eval_instant_ns": 0,
      "rule_version": 0,
      "trigger": "string",
      "outcome": "string",
      "value": {},
      "quality": 0,
      "reason": "string",
      "provisional": false,
      "computed_at_ns": 0,
      "inputs": {}
    }
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read calculation evaluation trace. The documented 200 response is recorded evaluations.

How it works

Reference

Required capability

read

Authorization scope

handler-resolved target

{
  "evaluations": [
    {
      "asset_id": "00000000-0000-4000-8000-000000000001",
      "output_series": "00000000-0000-4000-8000-000000000001",
      "window": {
        "start_ns": 0,
        "end_ns": 0
      },
      "eval_instant_ns": 0,
      "rule_version": 0,
      "trigger": "string",
      "outcome": "string",
      "value": {},
      "quality": 0,
      "reason": "string",
      "provisional": false,
      "computed_at_ns": 0,
      "inputs": {}
    }
  ]
}

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

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

{
  "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.

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

const response = await fetch(`${ordinateUrl}/v1/calc/rules/00000000-0000-4000-8000-000000000001/trace?asset_id=00000000-0000-4000-8000-000000000001&start_ns=0&end_ns=0`, {
  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);