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.

Gets measurements from the ID domain

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idsstringRequired

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.

get
/measurements/id/{ids}
GET /{ENVIRONMENT}/measurements/id/{ids} HTTP/1.1
Host: prism.raalabs.io/{ENVIRONMENT}
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

Get measurement data from the JSMEA domain

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
vesselstringOptional

The vessel to retrieve from.

Example: IMO1000002
short_naming_rulestringOptional

The short naming rule to retrieve from.

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

get
/measurements/jsmea/{vessel}/{short_naming_rule}/{category}/{sub_category}/{content}/{position}/{item}/{modifier}
GET /{ENVIRONMENT}/measurements/jsmea/{vessel}/{short_naming_rule}/{category}/{sub_category}/{content}/{position}/{item}/{modifier} HTTP/1.1
Host: prism.raalabs.io/{ENVIRONMENT}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "IMO1000002/jsmea_mac/MainEngine/Fuel/Input/Inlet/Energy/",
    "timestamp": "2025-01-01T12:00:31.000000Z",
    "value": 0.031
  },
  {
    "id": "IMO1000002/jsmea_mac/MainEngine/Fuel/Input/Inlet/Energy/",
    "timestamp": "2025-01-01T12:00:32.000000Z",
    "value": {
      "lat": 2,
      "lon": 32
    }
  }
]

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

post
/measurements/query
POST /{ENVIRONMENT}/measurements/query HTTP/1.1
Host: prism.raalabs.io/{ENVIRONMENT}
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_numberstringRequired

The IMO number of the vessel

Example: IMO1000001
tag_namestringRequired

Short descriptive tag. May include wildcard (*)

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

get
/measurements/raalabs/{imo_number}/{tag_name}
GET /{ENVIRONMENT}/measurements/raalabs/{imo_number}/{tag_name} HTTP/1.1
Host: prism.raalabs.io/{ENVIRONMENT}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "IMO1000001/ME FuelEnergy_0",
    "timestamp": "2025-01-01T00:00:01.000000Z",
    "value": 0.001
  },
  {
    "id": "IMO1000001/ME FuelEnergy_1",
    "timestamp": "2025-01-01T00:00:02.000000Z",
    "value": {
      "lat": 2,
      "lon": 2
    }
  }
]
PreviousAPI ReferenceNextMetadata

Last updated