Get fleet statistics

GET

/api/v1/groups/stats

const url = 'http://localhost:3000/api/v1/groups/stats';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/groups/stats \
  --header 'X-API-Key: <X-API-Key>'

Retrieves fleet-wide statistics including device counts and available label keys.

Authorizations

api-key
bearer

Parameters

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

Fleet statistics retrieved successfully

application/json

object

totalDevices

required

Total number of devices in the fleet

number

byStatus

required

Status breakdown of all devices

object

online

required

Number of online devices

number

offline

required

Number of offline devices

number

pending

required

Number of pending devices

number

error

required

Number of devices in error state

number

labelKeys

required

List of all label keys used in the organization

Array<string>

unlabeledDeviceCount

required

Number of devices with no labels assigned

number

Example

{
  "totalDevices": 150,
  "byStatus": {
    "online": 45,
    "offline": 5,
    "pending": 2,
    "error": 1
  },
  "labelKeys": [
    "environment",
    "region",
    "tier"
  ],
  "unlabeledDeviceCount": 3
}

401

Unauthorized

403

Forbidden — caller lacks required permission