Query group statistics
POST
/api/v1/groups/query
const url = 'http://localhost:3000/api/v1/groups/query';const options = { method: 'POST', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"labelSelector":{"environment":"production","region":"us-west"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:3000/api/v1/groups/query \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "labelSelector": { "environment": "production", "region": "us-west" } }'Retrieves statistics for devices matching a label selector.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type application/json
object
labelSelector
required
object
key
additional properties
string
Example
{ "environment": "production", "region": "us-west"}Responses
Section titled “ Responses ”Group statistics retrieved successfully
Media type 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" }}Unauthorized
Forbidden — caller lacks required permission