Get device telemetry

GET

/api/v1/devices/{id}/telemetry

curl --request GET \
  --url 'http://localhost:3000/api/v1/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/telemetry?from=2026-03-17T00%3A00%3A00Z&to=2026-03-18T00%3A00%3A00Z&interval=1m' \
  --header 'X-API-Key: <X-API-Key>'

• Development
• Production

Retrieves metric snapshots for a device within a time range, with optional downsampling.

Authorizations

• api-key
• bearer

Parameters

Path Parameters

id

required

string format: uuid

Device UUID

Query Parameters

from

string

Example

2026-03-17T00:00:00Z

Start of time range (ISO 8601)

to

string

Example

2026-03-18T00:00:00Z

End of time range (ISO 8601)

interval

string

default: 1m

Allowed values: 1m 5m 1h 1d

Aggregation interval for downsampling

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Telemetry data retrieved successfully

Media typeapplication/json

object

data

required

Array<object>

object

id

required

Snapshot ID

string

deviceId

required

Device ID

string

timestamp

required

Timestamp of the snapshot

string

cpuUsagePercent

CPU usage percentage (0-100)

object

memoryUsedBytes

Memory used in bytes

object

memoryTotalBytes

Memory total in bytes

object

memoryUsagePercent

Memory usage percentage (computed)

object

diskUsedBytes

Disk used in bytes

object

diskTotalBytes

Disk total in bytes

object

diskUsagePercent

Disk usage percentage (computed)

object

uptimeSeconds

System uptime in seconds

object

agentUptimeSeconds

Agent process uptime in seconds (absent for agents that do not report it)

object

restartCount

Number of restarts

object

containersRunning

Running containers count

object

containersFailed

Failed containers count

object

errorCount

Error count in the aggregation window

number

total

required

Total number of snapshots in range

number

Example^generated

{
  "data": [
    {
      "id": "example",
      "deviceId": "example",
      "timestamp": "example",
      "cpuUsagePercent": {},
      "memoryUsedBytes": {},
      "memoryTotalBytes": {},
      "memoryUsagePercent": {},
      "diskUsedBytes": {},
      "diskTotalBytes": {},
      "diskUsagePercent": {},
      "uptimeSeconds": {},
      "agentUptimeSeconds": {},
      "restartCount": {},
      "containersRunning": {},
      "containersFailed": {},
      "errorCount": 1
    }
  ],
  "total": 1
}

403

Forbidden — caller lacks required permission

404

Device not found