SitesSLEs
getSiteSleSummary
Deprecated
Get the summary for the SLE metric
This API Endpoint is deprecated and replaced by Get Site SLE Summary Trend
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
enum: ap, client, gateway, site, switch
Value in
- "ap"
- "client"
- "gateway"
- "site"
- "switch"
scope_id*string
- site_id if
scope==site - device_id if
scope==ap,scope==switchorscope==gateway - mac if
scope==client
metric*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"Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/sle/ap/string/metric/string/summary"{ "classifiers": [ { "impact": { "num_aps": 1, "num_users": 4, "total_aps": 3, "total_users": 26 }, "interval": 3600, "name": "client-count", "samples": { "degraded": [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5.8, 0, 0, 0, 4.65, 0, 7.55, 47.55, 13.266666 ], "duration": [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5.8, 0, 0, 0, 4.65, 0, 7.55, 47.55, 13.266666 ], "total": [ 1302.3, 1289.0167, 1396.3167, 1423.6666, 1439.2167, 1414.7, 1361.0834, 1371.5834, 1372.0667, 1339.1, 1374.3667, 1369.9, 1352.4833, 1382.8, 1426.7167, 1425.6333, 1403.9333, 1420.75, 1416.8334, 1437.3334, 1425.1, 1485.3667, 1426.4333, 289.83334 ] }, "x_label": "seconds", "y_label": "user-minutes" }, { "impact": { "num_aps": 2, "num_users": 17, "total_aps": 3, "total_users": 26 }, "interval": 3600, "name": "wifi-interference", "samples": { "degraded": [ 0, 0, 210.03334, 3.1333334, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 102.5, 108.03333, 0, 0, 201.9, 566.48334, 135.63333, 0 ], "duration": [ 0, 0, 210.03334, 3.1333334, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 102.5, 108.03333, 0, 0, 201.9, 566.48334, 135.63333, 0 ], "total": [ 1302.3, 1289.0167, 1396.3167, 1423.6666, 1439.2167, 1414.7, 1361.0834, 1371.5834, 1372.0667, 1339.1, 1374.3667, 1369.9, 1352.4833, 1382.8, 1426.7167, 1425.6333, 1403.9333, 1420.75, 1416.8334, 1437.3334, 1425.1, 1485.3667, 1426.4333, 289.83334 ] }, "x_label": "seconds", "y_label": "user-minutes" }, { "impact": { "num_aps": 0, "num_users": 0, "total_aps": 3, "total_users": 26 }, "interval": 3600, "name": "client_usage", "samples": { "degraded": [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ], "duration": [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ], "total": [ 1302.3, 1289.0167, 1396.3167, 1423.6666, 1439.2167, 1414.7, 1361.0834, 1371.5834, 1372.0667, 1339.1, 1374.3667, 1369.9, 1352.4833, 1382.8, 1426.7167, 1425.6333, 1403.9333, 1420.75, 1416.8334, 1437.3334, 1425.1, 1485.3667, 1426.4333, 289.83334 ] }, "x_label": "seconds", "y_label": "user-minutes" }, { "impact": { "num_aps": 1, "num_users": 17, "total_aps": 3, "total_users": 26 }, "interval": 3600, "name": "non-wifi-interference", "samples": { "degraded": [ 0, 0, 0, 0, 16.65, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 31.15, 17.616667, 17.85, 0, 0, 0, 0 ], "duration": [ 0, 0, 0, 0, 16.65, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 31.15, 17.616667, 17.85, 0, 0, 0, 0 ], "total": [ 1302.3, 1289.0167, 1396.3167, 1423.6666, 1439.2167, 1414.7, 1361.0834, 1371.5834, 1372.0667, 1339.1, 1374.3667, 1369.9, 1352.4833, 1382.8, 1426.7167, 1425.6333, 1403.9333, 1420.75, 1416.8334, 1437.3334, 1425.1, 1485.3667, 1426.4333, 289.83334 ] }, "x_label": "seconds", "y_label": "user-minutes" } ], "end": 1627312606, "events": [], "impact": { "num_aps": 2, "num_users": 21, "total_aps": 3, "total_users": 26 }, "sle": { "interval": 3600, "name": "capacity", "samples": { "degraded": [ 0, 0, 210.03334, 3.1333334, 16.65, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5.8, 102.5, 139.18333, 17.616667, 22.5, 201.9, 574.0333, 183.18333, 13.266666 ], "total": [ 1302.3, 1289.0167, 1396.3167, 1423.6666, 1439.2167, 1414.7, 1361.0834, 1371.5834, 1372.0667, 1339.1, 1374.3667, 1369.9, 1352.4833, 1382.8, 1426.7167, 1425.6333, 1403.9333, 1420.75, 1416.8334, 1437.3334, 1425.1, 1485.3667, 1426.4333, 289.83334 ], "value": [ 0.6764934, 0.6783766, 0.641645, 0.6934629, 0.68676674, 0.6834809, 0.6961604, 0.6979584, 0.7033722, 0.70410794, 0.7025278, 0.70305353, 0.70292175, 0.7009334, 0.69344264, 0.68596864, 0.5952168, 0.62183666, 0.68161446, 0.65352744, 0.6183489, 0.54178274, 0.6044712, 0.66845906 ] }, "x_label": "seconds", "y_label": "%" }, "start": 1627226206}getSiteSleImpactSummary GET
Get impact summary counts optionally filtered by classifier and failure type * Wireless SLE Fields: `wlan`, `device_type`, `device_os` ,`band`, `ap`, `server`, `mxedge` * Wired SLE Fields: `switch`, `client`, `vlan`, `interface`, `chassis` * WAN SLE Fields: `gateway`, `client`, `interface`, `chassis`, `peer_path`, `gateway_zones`
getSiteSleSummaryTrend GET
Get the summary for the SLE metric trend