SitesSLEs

listSiteSlesMetrics

GET
/api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics

List the metrics for the given scope

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

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/sle/ap/string/metrics"
{  "enabled": [    "coverage",    "capacity",    "time-to-connect",    "failed-to-connect",    "roaming",    "roaming-v2",    "throughput",    "switch_health",    "switch_throughput",    "switch_stc",    "gateway-health",    "application_health",    "wan-link-health",    "ap-availability"  ],  "supported": [    "coverage",    "capacity",    "time-to-connect",    "failed-to-connect",    "roaming",    "roaming-v2",    "location_jitter",    "location_latency",    "throughput",    "location_dropped-requests",    "switch_health",    "switch_throughput",    "switch_stc",    "gateway-health",    "application_health",    "wan-link-health",    "ap-availability",    "location_sdk-connect-time",    "location_ble-hung"  ]}