getSiteWirelessClientsStats

GET https://{{host}}/api/v1/sites/:site_id/stats/clients

Response Parameter

NameTypeDescription
macstringclient mac
hostnamestringhostname that we learned from sniffing DHCP
usernamestringusername that we learned from 802.1X exchange or Per-user PSK or User Portal
manufacturestringdevice manufacture, through fingerprinting or OUI
osstringdevice os, through fingerprinting
familystringdevice family, through fingerprinting. iPod / Nexus Galaxy / Windows Mobile or CE …
modelstringdevice model, may be available if we can identify them
ap_macstringAP the client is connected to
ap_idstringAP ID the client is connected to
ssidstringSSID the client is connected to
wlan_idstringWLAN ID the client is connected to
psk_idstringPSK id (if multi-psk is used)
uptimelonghow long, in seconds, has the client been connected
idle_timelonghow long, in seconds, has the client been idle (since the last RX packet)
last_seenlonglast seen timestamp
power_savingbooleanif it’s currently in power-save mode
bandstring“24” or “5”
protostringb / g / n / a / ac
key_mgmtstringe.g. WPA2-PSK/CCMP
dual_bandbooleanwhether the client is dual-band capable (determined by whether we’ve seen probe requests from both bands)
channelintcurrent channel
vlan_idstringvlan id, could be empty (from older AP)
rssiintsignal strength
snrintsignal over noise
tx_ratefloatTX Rate, Mbps
rx_ratefloatRX Rate, Mbps
tx_bpsfloatrate of transmitting traffic to the clients, bits/seconds, last known
rx_bpsfloatrate of receiving traffic from the clients, bits/seconds, last known
tx_bytesfloatamount of traffic sent to client since client connects
rx_bytesfloatamount of traffic received from client since client connects
tx_pktsfloatamount of traffic sent to client since client connects
rx_pktsfloatamount of traffic received from client since client connects
tx_retriesfloatamount of tx retries
rx_retriesfloatamount of rx retries
map_idstringestimated client location - map_id
xintestimated client location in pixels
yintestimated client location in pixels
x_mintestimated client location in meter
y_mintestimated client location in meter
num_locating_apsintnumber of APs used to locate this client
accuracyintestimated client location accuracy, in meter
is_guestbooleanwhether this is a guest, default is false
guestobjectinformation about this portal
authorizedbooleanwhether this guest is authorized, default is false
authorized_timeintwhen the guest is authorized
authorized_expiring_timeintwhen the guest authorization will expire
cross_sitebooleanwhether this guest is authorized for cross site, default is false
airwatchobjectinformation if airwatch enabled
_ttlintTTL of the validity of the stat