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 Mosquitto broker on a per-device topic:
devices/{deviceId}/telemetry
Payloads are flat JSON: readings as top-level keys. The platform stamps each frame on receipt, stores it, and fans it out to live subscribers.
Live Streams
Clients connect to /api/v1/ws and receive telemetry over STOMP on SockJS, subscribing to:
/topic/devices/{deviceId}/telemetry
Attributes, per-device status, and hub-level telemetry are published alongside it on /topic/devices/{deviceId}/attributes, /topic/devices/{deviceId}/status, and /topic/hubs/{hubId}/telemetry.
Query Endpoints
Historical data is queried per organization and project:
GET .../devices/{deviceId}/device-telemetries/time-series?startDate=...&endDate=...(ISO 8601) — telemetry history.../stats— aggregate statistics.../available-metrics— metric keys recorded for a device
History is stored at 1-second resolution and written in batches, so it trails the live stream by up to 60 seconds.