Measurements

The Measurements endpoints provide access to raw sensor data (time series measurements) without any aggregation. Each measurement is an instantaneous reading from a sensor at a given timestamp. This is typically the most commonly used endpoint for retrieving time-series data.

Get measurements from the id domain

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idsstringOptional

A comma-separated list of one or more GUIDs

Example: ba529839-8179-40e2-b3fb-5da01a8d76e8,e8317666-77f2-4185-ae48-847af57563db

Query parameters

fromstring · date-timeOptional

From date-time

Example: 2025-01-01T00:00:00.000000Z

tostring · date-timeOptional

To date-time

Example: 2025-01-01T00:00:10.000000Z

from_epochintegerOptional

From epoch. ex: 0

to_epochintegerOptional

To epoch. ex: 100000

sincestringOptional

Since returns data going back. ex: '1day' from now

laststringOptional

Last returns data going back. ex: '1day' from the last full day

yearnumberOptional

Sets the year for which data should be retrieved. ex: 2025

monthnumberOptional

Sets the month for which data should be retrieved. ex: 8

daynumberOptional

Sets the day for which data should be retrieved. ex: 1

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

Responses

200

All data points for the times series within the requested time range.

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/measurements/id/{ids}

GET /measurements/id/{ids} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "ba529839-8179-40e2-b3fb-5da01a8d76e8",
    "timestamp": "2025-01-01T00:00:00.000000Z",
    "value": 0.5
  },
  {
    "id": "e8317666-77f2-4185-ae48-847af57563db",
    "timestamp": "2025-01-01T00:00:10.000000Z",
    "value": 1.5
  }
]

Get measurement data from the jsmea domain

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

imo_numberstringOptional

The IMO number of the vessel to retrieve from

Example: IMO1000002

naming_rulestringOptional

The naming rule to use for retrieval

Example: jsmea_mac

categorystringOptional

The category to retrieve from

Example: MainEngine

sub_categorystringOptional

The sub category to retrieve from

Example: Fuel

contentstringOptional

The content to retrieve from

Example: Input

positionstringOptional

The position to retrieve from

Example: Inlet

itemstringOptional

The item to retrieve from

Example: Energy

modifierstringOptional

The modifier to retrieve from

Query parameters

fromstring · date-timeOptional

From date-time

Example: 2025-01-01T00:00:00.000000Z

tostring · date-timeOptional

To date-time

Example: 2025-01-01T00:00:10.000000Z

from_epochintegerOptional

From epoch. ex: 0

to_epochintegerOptional

To epoch. ex: 100000

sincestringOptional

Since returns data going back. ex: '1day' from now

laststringOptional

Last returns data going back. ex: '1day' from the last full day

yearnumberOptional

Sets the year for which data should be retrieved. ex: 2025

monthnumberOptional

Sets the month for which data should be retrieved. ex: 8

daynumberOptional

Sets the day for which data should be retrieved. ex: 1

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

Responses

200

Response from the route

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/measurements/jsmea/{imo_number}/{naming_rule}/{category}/{sub_category}/{content}/{position}/{item}/{modifier}

GET /measurements/jsmea/{imo_number}/{naming_rule}/{category}/{sub_category}/{content}/{position}/{item}/{modifier} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "IMO1000003/jsmea_nav/PositioningSystem/GPS///Longitude/",
    "timestamp": "2025-06-12T07:42:03.361000Z",
    "value": 120.225685
  },
  {
    "id": "IMO1000003/jsmea_nav/PositioningSystem/GPS///Latitude/",
    "timestamp": "2025-06-12T07:42:03.361000Z",
    "value": 36.008892
  }
]

Retrieve data from multiple queries

post

Used to retrieve data for multiple queries in one request (you provide a list of domain/expression queries in the JSON body).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

fromstring · date-timeOptional

From date-time

Example: 2025-01-01T00:00:00.000000Z

tostring · date-timeOptional

To date-time

Example: 2025-01-01T00:00:10.000000Z

from_epochintegerOptional

From epoch. ex: 0

to_epochintegerOptional

To epoch. ex: 100000

sincestringOptional

Since returns data going back. ex: '1day' from now

laststringOptional

Last returns data going back. ex: '1day' from the last full day

yearnumberOptional

Sets the year for which data should be retrieved. ex: 2025

monthnumberOptional

Sets the month for which data should be retrieved. ex: 8

daynumberOptional

Sets the day for which data should be retrieved. ex: 1

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

Bodystring[]

string[] · min: 1Optional

Array of domain/expression query strings

Example: ["raalabs/IMO1000001/ME*","id/00000000-0000-4000-8000-000000000000"]

Responses

200

Batch measurement data

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/measurements/query

POST /measurements/query HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

[
  "raalabs/IMO1000001/ME*",
  "id/00000000-0000-4000-8000-000000000000"
]

[
  {
    "id": "00000000-0000-4000-8000-000000000000",
    "timestamp": "2025-01-01T00:00:03.000000Z",
    "value": 1.5
  },
  {
    "id": "IMO1000001/ME FuelEnergy_0",
    "timestamp": "2025-01-01T12:00:01.000000Z",
    "value": 0.001
  }
]

Get measurement data from the raalabs domain

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

imo_numberstringOptional

The IMO number of the vessel

Example: IMO1000001

tag_namestringOptional

Short descriptive tag name

Example: ME FuelEnergy*

Query parameters

fromstring · date-timeOptional

From date-time

Example: 2025-01-01T00:00:00.000000Z

tostring · date-timeOptional

To date-time

Example: 2025-01-01T00:00:10.000000Z

from_epochintegerOptional

From epoch. ex: 0

to_epochintegerOptional

To epoch. ex: 100000

sincestringOptional

Since returns data going back. ex: '1day' from now

laststringOptional

Last returns data going back. ex: '1day' from the last full day

yearnumberOptional

Sets the year for which data should be retrieved. ex: 2025

monthnumberOptional

Sets the month for which data should be retrieved. ex: 8

daynumberOptional

Sets the day for which data should be retrieved. ex: 1

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

Responses

200

Response from the route

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/measurements/raalabs/{imo_number}/{tag_name}

GET /measurements/raalabs/{imo_number}/{tag_name} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "IMO1000001/ME FuelEnergy_0",
    "timestamp": "2025-01-01T00:00:01.000000Z",
    "value": 0.001
  }
]

Get measurement data from the vis-3-8a domain

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

imo_numberstringOptional

The IMO number of the vessel to retrieve from

Example: IMO1000001

primary_item_vis_pathstringOptional

Primary item VIS path

Example: 913/S130.1-2/S121

secondary_item_vis_pathstringOptional

Secondary item VIS path

Example: 406i/H233

metadatastringOptional

Metadata

Example: qty-power

Query parameters

fromstring · date-timeOptional

From date-time

Example: 2025-01-01T00:00:00.000000Z

tostring · date-timeOptional

To date-time

Example: 2025-01-01T00:00:10.000000Z

from_epochintegerOptional

From epoch. ex: 0

to_epochintegerOptional

To epoch. ex: 100000

sincestringOptional

Since returns data going back. ex: '1day' from now

laststringOptional

Last returns data going back. ex: '1day' from the last full day

yearnumberOptional

Sets the year for which data should be retrieved. ex: 2025

monthnumberOptional

Sets the month for which data should be retrieved. ex: 8

daynumberOptional

Sets the day for which data should be retrieved. ex: 1

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

verbosebooleanOptional

When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.

Default: false

Responses

200

Response from the route

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/measurements/vis-3-8a/{imo_number}/{primary_item_vis_path}/sec/{secondary_item_vis_path}/meta/{metadata}

GET /measurements/vis-3-8a/{imo_number}/{primary_item_vis_path}/sec/{secondary_item_vis_path}/meta/{metadata} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "IMO1000001/913/S130.1-2/S121/sec/406i/H233/meta/qty-power",
    "timestamp": "2025-01-01T00:00:01.000000Z",
    "value": 50.5
  }
]