reference

API Reference (Basic)

Basic API patterns for ingest and retrieval workflows.

API Reference (Basic)

Authentication

API auth uses organization-scoped JWTs: 1-hour access tokens refreshed automatically against a 30-day refresh token. Send the access token as a Bearer header on REST calls.

Telemetry Ingest

Devices publish telemetry over MQTT to a per-device topic:

device/{deviceId}/telemetry

Payloads are flat JSON: readings as top-level keys, with an optional timestamp field. The platform ingests frames server-side and fans them out to live subscribers.

Live Streams

Clients receive telemetry over STOMP on secure WebSockets, subscribing to:

/topic/devices/{deviceId}/telemetry

Query Endpoints

Historical data is queried per organization/project/context:

  • GET .../devices/{deviceId}/device-telemetries/time-series?startDate=...&endDate=... (ISO 8601) — telemetry history
  • .../stats — aggregate statistics
  • .../available-metrics — metric keys recorded for a device