SitesSLEs
listSiteSleImpactedWirelessClients
For Wireless SLEs. List the impacted wireless users optionally filtered by classifier and failure type
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
Format
uuidscope*string
Scope parameter value for impacted user SLE queries. enum: ap, site
Value in
- "ap"
- "site"
scope_id*string
Format
uuidmetric*string
Values from listSiteSlesMetrics
Query Parameters
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"classifier?string
Filter SLE impact results by classifier
Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/sle/ap/497f6eca-6276-4993-bfeb-53cbbbba6f08/metric/string/impacted-users"{ "classifier": "", "end": 1627313103, "failure": "", "limit": 1000, "metric": "capacity", "page": 1, "start": 1627226703, "total_count": 21, "users": [ { "ap_mac": "d420b0830000", "ap_name": "ap33.lab", "degraded": 2, "device_os": "14.6", "device_type": "iPhone", "duration": 1270, "mac": "dc080f360000", "name": "aPhone-20973", "ssid": "lab.1X", "total": 1270, "wlan_id": "a937da77-0000-0000-0000-f2134d7b1483" }, { "ap_mac": "5c5b35500000", "ap_name": "ap43.lab", "degraded": 36, "device_os": "Android 11", "device_type": "OnePlus", "duration": 767, "mac": "4c4feedc0000", "name": "OnePlus-8", "ssid": "lab.1X", "total": 767, "wlan_id": "a937da77-0000-0000-0000-f2134d7b1483" }, { "ap_mac": "5c5b35500000", "ap_name": "ap43.lab", "degraded": 2, "device_os": "Catalina", "device_type": "Mac", "duration": 1405, "mac": "a483e7390000", "name": "tmunzer-mbp", "ssid": "lab.1X", "total": 1405, "wlan_id": "a937da77-0000-0000-0000-f2134d7b1483" }, { "ap_mac": "5c5b35500000", "ap_name": "ap43.lab", "degraded": 81, "device_os": "Linux", "device_type": "unknown", "duration": 1403, "mac": "5caafd0d0000", "name": "SonosZP", "ssid": "lab", "total": 1403, "wlan_id": "649a2336-0000-0000-0000-f637dbe50e7b" } ]}