get_client_stats
get_client_stats
Section titled “get_client_stats”Report per-client traffic, signal, and uptime for one client by MAC.
Side effects: None (read-only).
Returns a record with hostname, name, ip, is_wired,
network, essid, uptime, first_seen/last_seen,
signal/rssi/satisfaction (wireless), tx_rate/rx_rate,
tx_bytes/rx_bytes, tx_retries, anomalies, and the wired
wired_rate_mbps/wired_tx_bytes/wired_rx_bytes fields when
present. Returns a NOT_FOUND error envelope if the client is not
currently connected.
Example
Section titled “Example”get_client_stats(mac="aa:bb:cc:00:00:01")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mac | string | yes | — | MAC address of the connected client. |
controller | string | no | ”default” | Name of the UniFi controller to target. Defaults to "default". |