--- title: "Wireless client health grid" method: POST path: "/dashboard/wireless/client-health/grid" tags: ["Dashboard Wireless Client Health"] --- # Wireless client health grid `POST /dashboard/wireless/client-health/grid` Returns the client health grid of wireless devices based on the provided filters. You can filter the results by sites. ## Query parameters - `page` integer - `limit` integer - `keyword` string - `connectionStatus` 'CONNECTED' | 'DISCONNECTED' | 'UNKNOWN' - `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' - `sortOrder` 'ASC' | 'DESC' — Sort Order - `includeUnassigned` boolean ## Request body - XiqClientGridFilter — Request body for Client Grid Filter - `site_ids` integer[] — The site ids - `device_ids` integer[] — The device ids - `number_filter` XiqNumberFilter[] — The health status - `column_name` string — The column name - `filter_type` 'GT' | 'GTE' | 'LT' | 'LTE' | 'EQ' | 'NEQ' | 'BTW' | 'BLANK' | 'NOT_BLANK' — The filter type - `value` integer — The value - `min` integer — The minimum value - `max` integer — The maximum value - `alias` string[] — The aliases - `auth_methods` string[] — The authentication methods - `encryption_methods` string[] — The encryption methods - `operating_systems` string[] — The operating systems - `ssids` string[] — The SSIDs - `user_profiles` string[] — The user profile names - `frequency` string[] — The frequency - `category_assignments` string[] — The category assignments - `has_authentication_issues` boolean — Flag to check authentication issues - `has_association_issues` boolean — Flag to check association issues - `has_ip_address_issues` boolean — Flag to check ip address issues - `has_roaming_issues` boolean — Flag to check roaming issues - `is_client_unhealthy` boolean — Flag to check unhealthy clients - `client_type` string[] — The client types ## Response `200` OK - PagedXiqClientHealthGridResponse - `page` integer, required — The current page number - `count` integer, required — The element count of the current page - `total_pages` integer, required — The total page number based on request page size - `total_count` integer, required — The total element count - `data` XiqClientHealthGridResponse[] — The data in the current page - `client_hostname` string — The hostname of the client - `client_ip` string, ipv4 or ipv6 — The IP address of the client - `site` string — The site where the client is located - `building` string — The building where the client is located - `floor` string — The floor where the client is located - `has_association_issues` boolean — The indicator of association issues - `has_authentication_issues` boolean — The indicator of authentication issues - `has_ip_address_issues` boolean — The indicator of IP address issues - `snr` integer — Signal-to-noise ratio of the client's connection in dB (decibels) - `rssi` integer — Received signal strength indicator of the client's connection in dBm (decibels-milliwatts) - `air_time` integer — The air time used by the client as a percentage (0-100%), calculated as average airtime ((Rx airtime + Tx airtime)/2) - `frequency` string — The frequency band used by the client (e.g., 2.4 GHz, 5 GHz, 6 GHz) - `has_roaming_issues` boolean — The indicator of roaming issues experienced by the client - `ipv4` string, ipv4 — The IPv4 address assigned to the client - `connected_device_mac` string — The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF'). - `ssid` string — The SSID of the network - `vlan` integer — The VLAN ID - `username` string — The username of the client - `authentication` string — The authentication method used - `encryption` string — The encryption method used - `user_profile` string — The user profile assigned to the client - `alias` string — The alias of the client - `category_assignment` string — The category assignment of the client - `ipv6` string, ipv6 — The IPv6 address assigned to the client - `slowness` integer — The slowness value of the IP Address in milliseconds - `client_device_id` integer — The client device ID - `device_id` integer — The device ID - `roaming_time` integer — The roaming time in milliseconds - `association_duration` integer — The association duration in milliseconds - `dhcp_ip_assignation_time` integer — The DHCP IP assignation time in milliseconds - `authentication_response_time` integer — The authentication response time in milliseconds - `rx_client_retries` integer — The number of RX client retries - `tx_client_retries` integer — The number of TX client retries - `ipv4_warning` boolean — The number of association issues - `air_time_warning` boolean — The number of association issues - `association_issues` integer — The number of association issues - `authentication_issues` integer — The number of authentication issues - `ip_address_issues` integer — The number of IP address issues - `roaming_issues` integer — The number of roaming issues experienced by the client - `client_type` 'WIRELESS' | 'THREAD' — Client type - `is_mlo` boolean — boolean to determine mlo ot not - `mlo_bands` string[] — supports mlo bands - `mlo_mode` 'STR' | 'eMLSR' | 'MLSR' | 'eMLMR' | 'NSTR' — MLO (Multi-Link Operation) mode - `rtts_supported` boolean — Indicates if RTTS is supported - `connected_device_hostname` string — Connected Device Hostname - `connectionStatus` 'CONNECTED' | 'DISCONNECTED' | 'UNKNOWN' - `last_session_start_time` integer — The start time of the last session (int64 epoch in milliseconds) - `operating_system` string — The operating system of the client device - `client_mac` string — The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF'). --- [API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)