Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Mist AI Sites Insights API

Insights is a feature that provides an overview of network experience across the entire site, access points, or clients.It offers useful information about current conditions, such as telemetry data from wired switches, edge devices, wireless clients, access points, network applications, and bluetooth low energy (ble) tags.These insights can be used to correct issues, make changes, and ensure a good network experience for users.

Juniper Mist AI Sites Insights API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sites Insights. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 2604.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

7 operations 7 paths 12 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Sites Insights API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
  • basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
  • csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Sites Insights 7

Insights is a feature that provides an overview of network experience across the entire site, access points, or clients. It offers useful information about current conditions, suc…

GET
/api/v1/sites/{site_id}/insights
getSiteInsightMetrics
getSiteInsightMetrics 8 params → 200400401403404429
GET
/api/v1/sites/{site_id}/insights/ap/{device_id}/stats
getSiteInsightMetricsForAP
getSiteInsightMetricsForAP 9 params → 200400401403404429
GET
/api/v1/sites/{site_id}/insights/client/{client_mac}
getSiteInsightMetricsForClient
getSiteInsightMetricsForClient 9 params → 200400401403404429
GET
/api/v1/sites/{site_id}/insights/device/{device_mac}/{metric}
getSiteInsightMetricsForDevice
getSiteInsightMetricsForDevice 10 params → 200400401403404429
GET
/api/v1/sites/{site_id}/insights/gateway/{device_id}/stats
getSiteInsightMetricsForGateway
getSiteInsightMetricsForGateway 10 params → 200400401403404429
GET
/api/v1/sites/{site_id}/insights/mxedge/{device_mac}/{metric}
getSiteInsightMetricsForMxEdge
getSiteInsightMetricsForMxEdge 10 params → 200400401403404429
GET
/api/v1/sites/{site_id}/insights/switch/{device_mac}/{metric}
getSiteInsightMetricsForSwitch
getSiteInsightMetricsForSwitch 10 params → 200400401403404429

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are response_device_metrics (7 properties), insight_metrics (5 properties), response_http404 (1 property), response_http401 (1 property). Each schema is shown below with its type and property counts.

strings
array
response_http403
object
1 property
insight_metrics_results
array
Results depends on the metric - some return numbers (e.g. bytes, ap-count), others return objects
response_device_metrics
object
7 properties 4 required
response_http404
object
1 property
insight_metrics_results_item
response_http400
object
1 property
response_http429
object
1 property
response_device_metrics_results_items
insight_metrics
object
5 properties 3 required
response_http401
object
1 property
response_device_metrics_results
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-sites-insights-api-openapi.yml Raw ↑

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API