OrdinateDB

Documentation

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

Read merged raw series points

operation ID: get_v1_series_by_uuid_raw

Overview

Read merged raw series points. 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 read merged raw series points.
  • 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/raw?start_ns=0&end_ns=0" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Merged points; gaps is present only when include_gaps=true

Example 200 output

{
  "points": [
    {
      "ts_ns": 0,
      "value": 0,
      "quality": 0
    }
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read merged raw series points. The documented 200 response is merged points; gaps is present only when include_gaps=true.

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
statqueryno
string

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

include_gapsqueryno
boolean

Request body

This operation has no request body.

Responses

200Merged points; gaps is present only when include_gaps=true

application/json

gapsarrayoptional

array

causestringrequired
detailstringrequired
end_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
start_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
unknown fields rejected
pointsarrayrequired

array

qualityintegerrequired
minimum: 0
ts_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
valueany ofrequired

Native typed value: number, boolean, string, or digital ordinal

any of

option 1

number

option 2

integerformat: int64

option 3

boolean

option 4

string

option 5

enum_setstringrequired
ordinalintegerrequired
format: int64
unknown fields rejected
unknown fields rejected
unknown fields rejected

Example 200 output

{
  "points": [
    {
      "ts_ns": 0,
      "value": 0,
      "quality": 0
    }
  ]
}
400Invalid UUID, range, or statistic

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/raw?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);