v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Client

Get client summary metrics

Get number of connected wireless clients and number of detected wired clients.

get/clients/summary

Query parameters

locationIdsinteger[]

The location IDs

deviceIdsinteger[]

The device IDs

vlansinteger[]

The associate VLAN IDs

userProfileNamesstring[]

The user profile names

ssidsstring[]

The SSIDs

clientOsNamesstring[]

The client os names

clientHealthStatusinteger

The client health status: 1 - HEALTHY, 2 - POOR

excludeLocallyManagedboolean

Return Cloud managed Devices' clients count

searchStringstring

The search string

Response

OK

connected_wireless_client_countinteger

The connected wireless client count

detected_wired_client_countinteger

The detected wired client count

connected_thread_client_countinteger

The connected thread client count