--- title: "List of Clients for filtering" method: POST path: "/ng-reports/metadata/client" tags: ["NG Reports (Ondemand)"] --- # List of Clients for filtering `POST /ng-reports/metadata/client` Gives List of Clients for filtering ## Request body - XiqQoeMetadataClientFilter - `site_ids` integer[] — The list of Site Ids - `building_ids` integer[] — The list of Building Ids - `floor_ids` integer[] — The list of Floor Ids - `usernames` string[] — The list of usernames ## Response `200` OK - XiqClient[] - `id` integer, required — The unique identifier - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format) - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format) - `org_id` integer — The organization identifier, valid when enabling HIQ feature - `location_id` integer — The location ID - `device_id` integer — The device ID - `hostname` string — The hostname of the client - `mac_address` string — The MAC address of the client - `ip_address` string — The IP address of the client - `ipv6_address` string — The IPv6 address of the client - `os_type` string — The OS type of the client - `username` string — The username of the client. - `user_profile_name` string — The user profile name of the client - `connected` boolean — Client is connected or not - `online_time` string, date-time — The online time for the client - `offline_time` string, date-time — The offline time for the client - `vlan` integer — The associate VLAN - `connection_type` integer — The connection type - `ssid` string — The SSID - `port` string — The associate device port - `org_name` string — The organization name - `device_function` integer — The associated device function - `device_mac_address` string — The associated device mac address - `device_name` string — The associated device name - `auth` integer — The authentication type - `channel` integer — The channel value - `client_health` integer — The health score of client - `application_health` integer — The health score of application - `radio_health` integer — The health score of radio - `network_health` integer — The health score of network - `radio_type` integer — The radio type. Represented by an integer code for each standard:
1 - 2.4G
2 - 5G
3 - WIRED
4 - 6G
5 - THREAD - `encryption_method` integer — The encryption method, represented by an integer code for each encryption type:
-1 - N/A (Not applicable)
0 - AES (Advanced Encryption Standard)
1 - TKIP (Temporal Key Integrity Protocol)
2 - WEP (Wired Equivalent Privacy)
3 - NON (No encryption)
4 - CCMP (Counter Mode with Cipher Block Chaining Message Authentication Code Protocol)
5 - KEYGUARD (Keyguard encryption)
6 - WEP128 (128-bit WEP encryption)
7 - WEP64 (64-bit WEP encryption)
8 - WAPI (WLAN Authentication and Privacy Infrastructure)
9 - GCMP256 (256-bit Galois/Counter Mode Protocol)
10 - NONE (No encryption)
11 - PAP (Password Authentication Protocol)
12 - MsCHAP (Microsoft Challenge Handshake Authentication Protocol)
13 - EAP-MD5 (Extensible Authentication Protocol - MD5)
14 - EAP-TLS (Extensible Authentication Protocol - Transport Layer Security)
15 - PEAP (Protected Extensible Authentication Protocol)
16 - TTLS (Tunneled Transport Layer Security)
17 - TTLS-INNER-TUNNEL (Inner tunnel for TTLS)
18 - PEAP-INNER-TUNNEL (Inner tunnel for PEAP)
19 - EAP-FAST (Extensible Authentication Protocol - Flexible Authentication via Secure Tunneling)
20 - EAP-LEAP (Lightweight Extensible Authentication Protocol)
21 - EAP-RSA (Extensible Authentication Protocol - RSA)
22 - EAP-SIM (Extensible Authentication Protocol - SIM)
23 - EAP-AKA (Extensible Authentication Protocol - AKA)
24 - EAP-TEAP (Extensible Authentication Protocol - Tunneled EAP) - `mac_protocol` string — The MAC protocol of the client:
'N/A'
'802.11a'
'802.11b'
'802.11g'
'802.11na'
'802.11ng'
'802.11ac'
'802.11ax-2.4g'
'802.11ax-5g'
'802.3'
'802.11ax-6g'
'802.15.4'
'802.11be-2g'
'802.11be-5g'
'802.11be-6g' - `interface_name` string — The interface name - `bssid` string — The bssid - `rssi` integer — The RSSI - `snr` integer — The SNR - `description` string — The description of client - `category` string — The category of client - `mobility` string — The client mobility - `port_type_name` string — The client port type name - `wing_ap` boolean — Wing ap flag - `vendor` string — The vendor of client - `locations` XiqLocationLegend[] — The detailed location - `id` integer — The location ID - `name` string — The location name - `product_type` string — The Category which describes the Extreme device types(For example:For example:SR_2208P, AP_4000, AP_5010) - `alias` string — The alias of the client - `th_rloc16` string — The thread client Rloc16 - `th_child_id` integer — The thread client child ID - `th_timeout` integer — The thread client timeout - `th_supervision_interval` integer — The thread client Super vision interval - `th_netdata_version` integer — The thread client netdata version - `th_csl_synced` boolean — The thread client CSL synced - `th_ip_addresses` XiqThreadIpv6Setting[] — The thread client IP addresses - `address` string - `scope` string - `cast` string - `type` string - `th_router_last_reported` string, date-time — The last reported datetime by thread router - `thread_connected` boolean — Is client connected to thread network - `make` string — The Manufacturer of the client associated device - `os_version` string — The OS version of the client associated device - `connected_to` string — The device name which client is connected to - `connection_duration` integer — The client's connection duration - `captive_web_portal` string — Captive Web Portal --- [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)