Get validated sensor data

GET

/validatedSensorData

const url = 'https://api.oriondata.io/api/validatedSensorData?startDate=2024-09-09&endDate=2024-09-16&offset=0&sensorIds=54321&softSensorIds=65432&version=1.3';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.oriondata.io/api/validatedSensorData?startDate=2024-09-09&endDate=2024-09-16&offset=0&sensorIds=54321&softSensorIds=65432&version=1.3' \
  --header 'Authorization: Bearer <token>'

Behaves like /sensorData but returns additional data-quality properties alongside each reading. Unless your integration specifically needs the data-quality fields, prefer /sensorData. At least one of sensorIds or softSensorIds must be supplied.

Authorizations

bearerAuth

Parameters

Query Parameters

startDate

required

string format: date-time

The start of the period. Date (yyyy-MM-dd) or DateTime (yyyy-MM-ddTHH:mm:ss).

Example

2024-09-09

endDate

required

string format: date-time

The end of the period. Date (yyyy-MM-dd) or DateTime (yyyy-MM-ddTHH:mm:ss).

Example

2024-09-16

offset

required

integer

The page of results to return, starting at 0. Each page contains up to 100 records.

Example

sensorIds

Array<integer>

Comma-separated list of raw Sensor IDs. At least one of sensorIds or softSensorIds must be supplied.

Example

?sensorIds=54321

softSensorIds

Array<integer>

Comma-separated list of Soft Sensor IDs. At least one of sensorIds or softSensorIds must be supplied.

Example

?softSensorIds=65432

version

string

API version to target. Pin this to 1.3 for this version of the API; requests without it default to the lowest available version.

Example

1.3

Responses

200

An array of ValidatedSensorData objects.

application/json

Array<object>

object

sensorId

The Sensor ID the data point belongs to.

integer

softSensorId

The Soft Sensor ID the data point belongs to. Null if the data point belongs to a raw sensor.

integer

nullable

readingDate

The reading timestamp in the Device’s local standard time. Devices do not observe daylight saving.

string format: date-time

sensorValue

The reading value.

number format: double

dataQualityApprovalLevelNameLong

The data point’s quality approval level.

string

Allowed values: 900 Raw - yet to review 1300 Audited 1600 Validated

dataQualityCodeLevelNameLong

The data point’s quality code level.

string

Allowed values: 100 Missing Record 200 No Quality or Non Verified 300 Not Recorded, Sensor Out Of Water 1 Good Quality 2 Edited Dataset 4 Estimated Record

comment

The auditor’s comment about the data point.

string

nullable

Example

[
  {
    "sensorId": 54321,
    "softSensorId": null,
    "readingDate": "2024-09-15T00:00:00",
    "sensorValue": 1025,
    "dataQualityApprovalLevelNameLong": "900 Raw - yet to review",
    "dataQualityCodeLevelNameLong": "200 No Quality or Non Verified",
    "comment": null
  }
]

400

The server could not understand the request.

401

No valid token was provided.

429

Rate limit exceeded.