Websocket Samples

Site Clients Stats

Subscribe to Client Stats Stream

Websocket Endpoint

WS /api-ws/v1/stream

Subscribe Command

{
    "subscribe": "/sites/{site_id}/stats/clients"
}

Streamed Data Sample

{
    "event": "data",
    "channel": "/sites/4ac1dcf4-xxxx-xxxx-xxxx-xxxxxxxxxxxx/stats/clients",
    "data": {
        "mac": "xxxxxxxxxxxx",
        "last_seen": 1470417522,

        "username": "david@mist.com",
        "hostname": "David-Macbook",
        "os": "OS X 10.10.2",
        "manufacture": "Apple",
        "family": "iPhone",
        "model": "6S",

        "ip": "192.168.1.8",
        "ip6": "2001:db8:3333:4444:5555:6666:7777:8888",

        "ap_mac": "xxxxxxxxxxxx",
        "ap_id": "0000000-0000-0000-1000-xxxxxxxxxxxx",
        "ssid": "corporate",
        "wlan_id": "be22bba7-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "psk_id": "732daf4e-xxxx-xxxx-xxxx-xxxxxxxxxxxx",

        "uptime": 3568,
        "idle_time": 3,
        "power_saving": true,
        "band": "24",
        "proto": "a",
        "key_mgmt": "WPA2-PSK/CCMP",
        "dual_band": false,

        "channel": 7,
        "vlan_id": "",
        "airespace_ifname": "",
        "rssi": -65,
        "snr": 31,
        "tx_rate": 65,
        "rx_rate": 65,

        "tx_bytes": 175132,
        "tx_bps": 6,
        "tx_packets": 1566,
        "tx_retries": 500,
        "rx_bytes": 217416,
        "rx_bps": 12,
        "rx_packets": 2337,
        "rx_retries": 5,

        "map_id": "63eda950-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "x": 53.5,
        "y": 173.1,
        "x_m": 5.35
        "y": 17.31
        "num_locating_aps": 3,

        "is_guest": true,
        "guest": {
            "authorized": true,
            "authorized_time": 1428939300,
            "authorized_expiring_time": 1429109300

            "name": "John",
            "email": "john@abc.com",
            "company": "ABC",
            "field1": "whatever",
            "cross_site": true
        },
        "airwatch": {
            "authorized": true
        },
        "_ttl": 250
    }
}

On this page