searchSiteWirelessClientSessions
Search wireless client sessions for a site with filters for AP, SSID, WLAN, client attributes, PSK, and time range. Use Search Org Wireless Client Sessions to search wireless client sessions across the organization.
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidQuery Parameters
Filter results by AP MAC address
802.11 band used to filter radio results. enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable
Value in
- "24"
- "5"
- "5-dedicated"
- "5-selectable"
- "6"
- "6-dedicated"
- "6-selectable"
E.g. "Mac", "iPhone", "Apple watch"
Filter results by client manufacturer, e.g. "Apple"
Filter results by client model, e.g. "8+", "XS"
Filter results by client username
E.g. "Mojave", "Windows 10", "Linux"
Filter results by SSID
Filter results by WLAN identifier
PSK identifier used to filter the results
Filter results by PSK name
Maximum number of results to return per page
0 <= value100Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"On which field the list should be sorted, -prefix represents DESC order
"timestamp"Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.
Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/clients/sessions/search"{ "end": 1513177200, "limit": 10, "results": [ { "ap": "5c5b350e0262", "band": "5", "client_manufacture": "Apple", "connect": 1565208388, "disconnect": 1565208448, "duration": 60.09423865, "mac": "b019c66c8348", "org_id": "3139f2c2-fac6-11e5-8156-0242ac110006", "site_id": "70e0f468-fc13-11e5-85ad-0242ac110008", "ssid": "Dummy WLAN 2", "tags": [ "disassociate" ], "timestamp": 1565208448.662, "wlan_id": "99bb4c74-f954-4f36-b844-6b030faffabc" } ], "start": 1511967600, "total": 100}searchSiteWirelessClientEvents GET
Search wireless client events for a site with filters for event type, AP, SSID, WLAN, radio band, and time range. Use [Search Org Wireless Client Events](/api/mist/orgs/orgs-clients/orgs-clients---wireless/searchOrgWirelessClientEvents) to search wireless client events across the organization.
searchSiteWirelessClients GET
Search wireless clients connected to a site with filters for client identity, AP, SSID, VLAN, radio band, and time range. Fuzzy matching with `*` is supported on `mac`, `hostname`, `device`, `os`, and `model`, for example `/clients/search?device=Mac*&hostname=jerry`. Use [Search Org Wireless Clients](/api/mist/orgs/orgs-clients/orgs-clients---wireless/searchOrgWirelessClients) to search wireless clients across the organization.