Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Dashboard Wireless Client Health

Wireless client health grid

Returns the client health grid of wireless devices based on the provided filters. You can filter the results by sites.

post/dashboard/wireless/client-health/grid

Query parameters

pageinteger

Page number, min = 1

limitinteger

Page Size, min = 1, max = 100

keywordstring

The keyword to search

connectionStatus'CONNECTED' | 'DISCONNECTED' | 'UNKNOWN'

Connection Status

sortField'OPERATING_SYSTEM' | 'FREQUENCY' | 'SSID' | 'CONNECTION_STATUS' | 'ALIAS' | 'CLIENT_MAC' | 'CATEGORY_ASSIGNMENT' | 'USER_PROFILE' | 'CLIENT_IP' | 'CONNECTED_DEVICE_MAC' | 'ENCRYPTION' | 'IPV4' | 'IPV6' | 'VLAN' | 'RSSI' | 'SNR' | 'AIR_TIME' | 'CLIENT_DEVICE_ID' | 'RX_CLIENT_RETIRES' | 'TX_CLIENT_RETIRES' | 'AUTHENTICATION' | 'CLIENT_TYPE'

Sort Field

sortOrder'ASC' | 'DESC'

Sort Order

Sort Order

includeUnassignedboolean

Whether to include unassigned devices

Request body

site_idsinteger[]

The site ids

device_idsinteger[]

The device ids

aliasstring[]

The aliases

auth_methodsstring[]

The authentication methods

encryption_methodsstring[]

The encryption methods

operating_systemsstring[]

The operating systems

ssidsstring[]

The SSIDs

user_profilesstring[]

The user profile names

frequencystring[]

The frequency

category_assignmentsstring[]

The category assignments

has_authentication_issuesboolean

Flag to check authentication issues

has_association_issuesboolean

Flag to check association issues

has_ip_address_issuesboolean

Flag to check ip address issues

has_roaming_issuesboolean

Flag to check roaming issues

is_client_unhealthyboolean

Flag to check unhealthy clients

client_typestring[]

The client types

Response

OK

pageinteger required

The current page number

countinteger required

The element count of the current page

total_pagesinteger required

The total page number based on request page size

total_countinteger required

The total element count

Example response

{
  "data": [
    {
      "client_ip": "h:h:h:h:h:h:h:h",
      "snr": 40,
      "rssi": -60,
      "air_time": 75,
      "ipv4": "192.168.1.1",
      "connected_device_mac": "AABBCCDDEEFF",
      "ipv6": "h:h:h:h:h:h:h:h",
      "slowness": 100,
      "roaming_time": 5000,
      "association_duration": 3600000,
      "dhcp_ip_assignation_time": 2000,
      "authentication_response_time": 1500,
      "rx_client_retries": 3,
      "tx_client_retries": 2,
      "last_session_start_time": 1622548800000,
      "client_mac": "AABBCCDDEEFF"
    }
  ]
}