Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesClientsWireless

getSiteEventsForClient

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

Get the list of events for a specific client

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
client_mac*string
Match^[0-9a-fA-F]{12}$

Query Parameters

type?string

Filter results by type, e.g. MARVIS_EVENT_CLIENT_DHCP_STUCK

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

Filter available versions by release channel

wlan_id?string

Filter results by WLAN identifier

ssid?string

Filter results by SSID

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"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/clients/0000000000ab/events"
{  "end": 1513176951,  "limit": 10,  "results": [    {      "ap": "5c5b350eb31b",      "band": "5",      "bssid": "5c5b350918f1",      "channel": 149,      "proto": "ac",      "ssid": "Guest",      "text": "Status code 0 \"Successful\"",      "timestamp": 1513358874.667,      "type": "CLIENT_DNS_OK",      "type_code": 15,      "wlan_id": "be22bba7-8e22-e1cf-5185-b880816fe2cf"    }  ],  "start": 1512572151,  "total": 1}

countSiteWirelessClients GET

Count wireless clients for a site, optionally grouped by the `distinct` field and filtered by client attributes and time range. Use [Count Org Wireless Clients](/api/mist/orgs/orgs-clients/orgs-clients---wireless/countOrgWirelessClients) to count wireless clients across the organization.

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.