Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesClientsWireless

searchSiteWirelessClientEvents

GET
/api/v1/sites/{site_id}/clients/events/search

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 to search wireless client events across the organization.

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

site_id*string
Formatuuid

Query Parameters

type?string

See List Device Events Definitions

reason_code?integer

Reason code filter for association and disassociation events

ssid?string

Filter results by SSID

ap?string

Filter results by AP MAC address

proto?string

802.11 protocol used to filter results. enum: a, ac, ax, b, be, g, n

Value in

  • "a"
  • "ac"
  • "ax"
  • "b"
  • "be"
  • "g"
  • "n"
band?string

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"
wlan_id?string

Filter results by WLAN identifier

nacrule_id?string

Filter results by NAC rule identifier

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/sites/000000ab-00ab-00ab-00ab-0000000000ab/clients/events/search"
{  "end": 0,  "limit": 0,  "results": [    {      "ap": "string",      "band": "24",      "bssid": "string",      "channel": 0,      "proto": "a",      "ssid": "string",      "text": "string",      "timestamp": 0,      "type": "string",      "type_code": 0,      "wlan_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"    }  ],  "start": 0,  "total": 0}

getSiteEventsForClient GET

Get the list of events for a specific client

searchSiteWirelessClientSessions GET

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](/api/mist/orgs/orgs-clients/orgs-clients---wireless/searchOrgWirelessClientSessions) to search wireless client sessions across the organization.