Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
MspsSLEs

getMspSle

GET
/api/v1/msps/{msp_id}/insights/{metric}

Return MSP-level SLE insight metrics for the selected metric and time range. Depending on the metric, the response can include all organizations or the worst-performing organizations in the MSP.

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

msp_id*string
Formatuuid
metric*string

See List Insight Metrics for available metrics

Query Parameters

sle?string

See List Insight Metrics for more details

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.

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

Response Body

curl -X GET "https://example.com/api/v1/msps/000000ab-00ab-00ab-00ab-0000000000ab/insights/string"
{  "end": 1643706000,  "interval": 3600,  "limit": 100,  "results": [    {      "ap-availability": 0.9919400860511628,      "ap-health": 0.967607512909879,      "capacity": 0.7484652273070254,      "coverage": 0.91217567374857,      "num_aps": 13,      "num_clients": 12,      "org_id": "ab0aca7a-d45c-469b-b3bb-4fe240642d0b",      "roaming": 0.991735537682683,      "roaming-exp": 0.991735537682683,      "successful-connect": 0.46052632135780236,      "throughput": 0.6775702123846302,      "time-to-connect": 0.9349112447196916    },    {      "ap-availability": 0.9990384613092129,      "ap-health": 0.48201754375507955,      "capacity": 0.9702673450306101,      "coverage": 0.8335392334930375,      "num_aps": 1,      "num_clients": 6,      "org_id": "49ff76e0-a283-4e7d-b38d-041f1e9aff3c",      "roaming": 1,      "roaming-exp": 1,      "successful-connect": 1,      "throughput": 0,      "time-to-connect": 1    },    {      "ap-availability": 1,      "ap-health": 0.982456140612301,      "capacity": 1,      "coverage": 0.9276041182442488,      "num_aps": 2,      "num_clients": 3,      "org_id": "9b9b48f1-15a4-459e-86cc-9cbec9005983",      "roaming": 1,      "roaming-exp": 1,      "successful-connect": 1,      "throughput": 1,      "time-to-connect": 0.8125    },    {      "ap-availability": 0.9981132070973234,      "ap-health": 0.9991228068084047,      "capacity": 1,      "coverage": 1,      "num_aps": 1,      "num_clients": 0,      "org_id": "eb0e1671-7a6b-472b-94c3-c187dafe5274",      "roaming": 1,      "roaming-exp": 1,      "successful-connect": 1,      "throughput": 0,      "time-to-connect": 0.5    }  ],  "start": 1643670000}

searchMspOrgs GET

Search organizations under this MSP using organization identifiers, names, subscription state, trial state, usage types, and time-based filters. Only organizations with at least one claimed device are returned.

listMspSsos GET

List SSO identity provider configurations defined for this MSP.