Sign in
Docs
API referenceSensors

API reference

Get a sensor's readings

Have a token? Manage tokens in the console
GET
/v1/atlas/sensors/{sensor_id}/readings

Readings in a window: raw when step is empty, else roll-ups per step with count, min, max, sum and the last state. At most 2000 points; truncated says when more were there.

Needs scope atlas-signals:read.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

sensor_id*string

The sensor, sen_ and a ULID.

Query Parameters

account_id?string

A team you belong to, to act on its events; empty for your own account.

from?string

RFC 3339; default an hour ago.

to?string

RFC 3339; default now.

step?string

1m, 5m, 1h or 1d; empty for raw readings.

Response Body

iohr.sensors.v1.ReadingsResponse

application/json
  1. response

iohr.sensors.v1.ReadingsResponse

readings*array<>
rollups*array<>
truncated*boolean
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.sensors.readings("<sensor_id>");  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "readings": [    {      "cursor": "string",      "evidence_digest": "string",      "labels": {        "property1": "string",        "property2": "string"      },      "produced_at": "string",      "received_at": "string",      "sensor_id": "string",      "skewed": true,      "state": "string",      "value": 0.1    }  ],  "rollups": [    {      "count": "string",      "last_state": "string",      "max": 0.1,      "min": 0.1,      "start": "string",      "sum": 0.1    }  ],  "truncated": true}