Skip to Content

Fleet

Fleet health

GET/v1/fleet/health

Returns device counts across the org.

Example

curl https://api.plexus.company/v1/fleet/health \ -H "x-api-key: YOUR_API_KEY"

Response

{ "sources_total": 24, "sources_online": 19 }

Fleet metrics

GET/v1/fleet/metrics

Query a single metric across all devices. Returns one time-series per device.

Query params

ParamExampleDescription
metriccpu.percentMetric name to query (required)
last1h, 30m, 7dRelative time window. Units: m, h, d only.
start2026-05-01T00:00:00ZISO 8601 start time
end2026-05-02T00:00:00ZISO 8601 end time

The interval is auto-computed from the window and is always at least 1m for fleet queries (no raw-row mode). The chosen interval is returned in the response.

Example

curl "https://api.plexus.company/v1/fleet/metrics?metric=cpu.percent&last=1h" \ -H "x-api-key: YOUR_API_KEY"

Response

{ "metric": "cpu.percent", "interval": "1h", "sources_online": 19, "sources_w_metric": 22, "sources": [ { "source_id": "robot-01", "online": true, "timestamp_ms": [1746969600000, 1746973200000], "avg": [14.2, 18.7], "min": [8.1, 11.3], "max": [31.4, 44.2], "count": [60, 60] } ] }

sources_w_metric is the number of devices that reported this metric within the requested window — the same as the length of the sources array. Each device’s series uses parallel arrays — same format as the single-device query.

Last updated on