SitesSLEs

getSiteSleHistogram

GET
/api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/histogram

Get the histogram for the SLE metric

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"

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/sle/ap/string/metric/string/histogram"
{  "data": [    {      "range": [        null,        0      ],      "value": 0    },    {      "range": [        0,        10      ],      "value": 0    },    {      "range": [        10,        20      ],      "value": 5105    },    {      "range": [        20,        30      ],      "value": 10616    },    {      "range": [        30,        40      ],      "value": 40051    },    {      "range": [        40,        50      ],      "value": 141201    },    {      "range": [        50,        60      ],      "value": 949823    },    {      "range": [        60,        70      ],      "value": 686308    },    {      "range": [        70,        80      ],      "value": 177670    },    {      "range": [        80,        90      ],      "value": 689    },    {      "range": [        90,        100      ],      "value": 0    },    {      "range": [        100,        null      ],      "value": 0    }  ],  "end": 1627055181,  "metric": "capacity",  "start": 1626968781,  "x_label": "available_bandwidth(%)",  "y_label": "seconds"}