OrgsSLEs

getOrgSitesSle

GET
/api/v1/orgs/{org_id}/insights/sites-sle

Return per-site Service-Level Expectation (SLE) scores for Wi-Fi, wired, or WAN service over the requested time window.

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

org_id*string
Formatuuid

Query Parameters

sle?string

Filter insights by SLE name. enum: wan, wifi, wired

Value in

  • "wan"
  • "wifi"
  • "wired"
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"
interval?string

Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/insights/sites-sle"

{  "end": 1651323600,  "interval": 3600,  "limit": 1,  "page": 2,  "results": [    {      "application_health": 0.8250000047942866,      "gateway-health": 1,      "num_clients": 65,      "num_gateways": 1,      "site_id": "f5fcbee5-1234-5678-9101-1619ede87879",      "wan-link-health": 0.9988471089272484    }  ],  "start": 1651269600,  "total": 4}