Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesEvents

listSiteRoamingEvents

GET
/api/v1/sites/{site_id}/events/fast_roam

List Roaming Events data

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

Event type used to filter results. enum: fail, none, success

Value in

  • "fail"
  • "none"
  • "success"
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"

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/events/fast_roam"
{  "end": 1501023379,  "limit": 2,  "next": "/api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/fast_roam?type=success&start=1428939600&end=1428949600&limit=200&token=AAAAEgAIAAVVJh4hF8AAAARzc2lkAH%2F%2F%2F%2F0%3D",  "results": [    {      "ap_mac": "5c5b350e040b",      "client_mac": "dc2b2a3fb13d",      "fromap": "5c5b350e0569",      "latency": 0.1874195,      "ssid": "marvis_test",      "subtype": "CLIENT_AUTHENTICATED_11R",      "timestamp": 1501000002283782    }  ],  "start": 1500940800}

countSiteSystemEvents GET

Count system events for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org System Events](/api/mist/orgs/orgs-events/countOrgSystemEvents) to count system events across the organization.

searchSiteSystemEvents GET

Search system events for a site with time range, sorting, and pagination controls. Use [Search Org System Events](/api/mist/orgs/orgs-events/searchOrgSystemEvents) to search system events across the organization.