SitesSLEs

getSiteSleImpactSummary

GET
/api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impact-summary

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

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
scope*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==switch or scope==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"
fields?string

Additional response fields to include, as a comma-separated list or * for all fields. enum: ap, band, chassis, client, device_os, device_type, gateway, gateway_zones, interface, mxedge, peer_path, server, switch, vlan, wlan

Value in

  • "ap"
  • "band"
  • "chassis"
  • "client"
  • "device_os"
  • "device_type"
  • "gateway"
  • "gateway_zones"
  • "interface"
  • "mxedge"
  • "peer_path"
  • "server"
  • "switch"
  • "vlan"
  • "wlan"
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/string/metric/string/impact-summary"
{  "ap": [    {      "ap_mac": "5c5b3550bd2e",      "degraded": 1486,      "duration": 0,      "name": "ap43-off.lab",      "total": 27406    },    {      "ap_mac": "d420b083e17a",      "degraded": 3,      "duration": 0,      "name": "ap33-ent.lab",      "total": 1193    }  ],  "band": [    {      "band": "24",      "degraded": 1410,      "duration": 0,      "name": "24",      "total": 28536    },    {      "band": "5",      "degraded": 78,      "duration": 0,      "name": "5",      "total": 4679    }  ],  "classifier": "",  "device_os": [    {      "degraded": 1329,      "device_os": "",      "duration": 0,      "name": "unknown",      "total": 27165    },    {      "degraded": 81,      "device_os": "Linux",      "duration": 0,      "name": "Linux",      "total": 1437    },    {      "degraded": 36,      "device_os": "Android 11",      "duration": 0,      "name": "Android 11",      "total": 761    },    {      "degraded": 39,      "device_os": "14.6",      "duration": 0,      "name": "14.6",      "total": 2413    },    {      "degraded": 2,      "device_os": "Catalina",      "duration": 0,      "name": "Catalina",      "total": 1438    }  ],  "device_type": [    {      "degraded": 1410,      "device_type": "",      "duration": 0,      "name": "unknown",      "total": 28603    },    {      "degraded": 2,      "device_type": "iPhone",      "duration": 0,      "name": "iPhone",      "total": 1263    },    {      "degraded": 36,      "device_type": "OnePlus",      "duration": 0,      "name": "OnePlus",      "total": 761    },    {      "degraded": 37,      "device_type": "iPad",      "duration": 0,      "name": "iPad",      "total": 1150    },    {      "degraded": 2,      "device_type": "Mac",      "duration": 0,      "name": "Mac",      "total": 1438    }  ],  "end": 1627312734,  "failure": "",  "metric": "capacity",  "start": 1627226334,  "wlan": [    {      "degraded": 37,      "duration": 0,      "name": "MlN.ADM",      "total": 1150,      "wlan_id": "ba3f85fc-ba48-4d8f-ad89-152e5c42db18"    },    {      "degraded": 1410,      "duration": 0,      "name": "MlN",      "total": 28603,      "wlan_id": "649a2336-b1e0-47bd-961c-f637dbe50e7b"    },    {      "degraded": 41,      "duration": 0,      "name": "MlN.1X",      "total": 3462,      "wlan_id": "a937da77-fe3c-4784-86c4-f2134d7b1483"    }  ]}