Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsClientsWireless

searchOrgWirelessClientSessions

GET
/api/v1/orgs/{org_id}/clients/sessions/search

Search historical wireless client sessions across the organization with filters for AP, band, client family, manufacturer, model, OS, username, SSID, WLAN, PPSK, and time range.

Authorization

Authorization<token>

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

org_id*string
Formatuuid

Query Parameters

ap?string

Filter results by AP MAC address

band?string

802.11 band used to filter radio results. enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable. Accepts multiple comma-separated values.

client_family?string

E.g. "Mac", "iPhone", "Apple watch". Accepts multiple comma-separated values.

client_manufacture?string

Filter results by client manufacturer, e.g. "Apple". Accepts multiple comma-separated values.

client_model?string

Filter results by client model, e.g. "8+", "XS". Accepts multiple comma-separated values.

client_username?string

Filter results by client username. Accepts multiple comma-separated values.

client_os?string

E.g. "Mojave", "Windows 10", "Linux". Accepts multiple comma-separated values.

ssid?string

Filter results by SSID. Accepts multiple comma-separated values.

wlan_id?string

Filter results by WLAN identifier

Formatuuid
psk_id?string

PSK identifier used to filter the results

psk_name?string

Filter results by PSK name. Accepts multiple comma-separated values.

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"
search_after?string

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/orgs/000000ab-00ab-00ab-00ab-0000000000ab/clients/sessions/search?band=5%2C6"
{  "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}

searchOrgWirelessClientEvents GET

Search wireless client event records across the organization with filters for event type, reason code, SSID, AP, key management, protocol, band, WLAN, NAC rule, and time range.

searchOrgWirelessClients GET

Search wireless client records across the organization with filters for site, AP, band, device identity, hostname, IP, MAC address, username, SSID, PPSK, VLAN, and time range.