Get group statistics via query params

GET

/api/v1/groups/query

const url = 'http://localhost:3000/api/v1/groups/query';
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/query \
  --header 'X-API-Key: <X-API-Key>'

Retrieves statistics for devices matching label query parameters. Pass label key-value pairs as query parameters (e.g., ?env=prod&region=us-east). Reserved keys limit and offset are excluded from label matching and must be non-negative integers. The pairs must form a valid label selector: 1-20 pairs, one value per key, keys 1-253 and values up to 253 characters, no control characters. An empty selector is rejected with 400; use GET /api/v1/groups/stats for the whole fleet.

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

Group statistics retrieved successfully

application/json

object

total

required

Total number of matching devices

number

byStatus

required

Status breakdown of matching 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

labelSelector

The label selector used for filtering

object

key

additional properties

string

Example

{
  "total": 25,
  "byStatus": {
    "online": 45,
    "offline": 5,
    "pending": 2,
    "error": 1
  },
  "labelSelector": {
    "environment": "production"
  }
}

400

The query parameters do not form a valid, non-empty label selector

401

Unauthorized

403

Forbidden — caller lacks required permission