OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
GET/v1/series/{uuid}/render

Render a numeric series for a pixel width

operation ID: get_v1_series_by_uuid_render

Overview

Render a numeric series for a pixel width. Series-storage operations expose registered series, direct stored data, gap and chunk metadata, and lifecycle controls.

When to use it

  • Use it when an application needs to render a numeric series for a pixel width.
  • Use it when a diagnostic or maintenance tool needs storage-level series data instead of model-resolved attributes.

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/series/00000000-0000-4000-8000-000000000001/render?start_ns=0&end_ns=0&width=0" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Significant-points or min/max-band rendering; t_ms intentionally uses float milliseconds

Example 200 output

{
  "t_ms": [
    0
  ],
  "v": [
    0
  ],
  "provenance": {
    "percentGood": 0,
    "mode": "significant-points",
    "pointsScanned": 0
  },
  "transitions": [
    {
      "t_ms": 0,
      "kind": "good-bad"
    }
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to render a numeric series for a pixel width. The documented 200 response is significant-points or min/max-band rendering; t_ms intentionally uses float milliseconds.

How it works

These routes address a stable series UUID directly. Use resolved-read routes when an application should follow model bindings across time.

Reference

Required capability
read
Authorization scope
owning asset of series path parameter `uuid`, or staging-root

Parameters

NameInRequiredType and constraints
uuidpathyes
stringformat: uuid
start_nsqueryyes
integer

UTC Unix timestamp in nanoseconds

format: int64
end_nsqueryyes
integer

UTC Unix timestamp in nanoseconds

format: int64
widthqueryyes
integerminimum: 0
modequeryno
string

values: significant-points · minmax-band

statqueryno
string

values: count · min · max · first · last · twa · percent_good

Request body

This operation has no request body.

Responses

200Significant-points or min/max-band rendering; t_ms intentionally uses float milliseconds

application/json

one of

option 1

provenanceobjectrequired
unknown fields rejected
modestringrequired
percentGoodnumberrequired
format: double
pointsScannedintegerrequired
minimum: 0
unknown fields rejected
t_msarrayrequired

array

numberformat: double
transitionsarrayrequired

array

kindstringrequired
t_msnumberrequired
format: double
unknown fields rejected
varrayrequired

array

numberformat: double
unknown fields rejected

option 2

percent_goodnumberrequired
format: double
points_scannedintegerrequired
minimum: 0
t_msarrayrequired

array

numberformat: double
transitionsarrayrequired

array

kindstringrequired
t_msnumberrequired
format: double
unknown fields rejected
v_maxarrayrequired

array

numberformat: double
v_minarrayrequired

array

numberformat: double
unknown fields rejected

Example 200 output

{
  "t_ms": [
    0
  ],
  "v": [
    0
  ],
  "provenance": {
    "percentGood": 0,
    "mode": "significant-points",
    "pointsScanned": 0
  },
  "transitions": [
    {
      "t_ms": 0,
      "kind": "good-bad"
    }
  ]
}
400Invalid UUID, range, render mode, statistic, or string series

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 400 output

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

text/plain

string
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"
}

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/series/00000000-0000-4000-8000-000000000001/render?start_ns=0&end_ns=0&width=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);