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 Zones API

A Zone is a custom area defined by a user on a floor plan.Zones can be used for capturing entry and exit events of clients, assets, and sdk clients, providing insights such as wait time and the number of devices in a particular zone.Zone notifications can be accessed using sdk notification callbacks.Zones are useful for data collection specific to areas on the floor plan.

Juniper Mist AI Sites Zones 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 Zones. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 26 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 4 paths 26 schemas 1 DELETE4 GET1 POST1 PUT

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 Zones 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 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Sites Zones 7

A Zone is a custom area defined by a user on a floor plan. Zones can be used for capturing entry and exit events of clients, assets, and sdk clients, providing insights such as wa…

GET
/api/v1/sites/{site_id}/zones
listSiteZones
listSiteZones 3 params → 200400401403404429
POST
/api/v1/sites/{site_id}/zones
createSiteZone
createSiteZone 1 param body → 200400401403404429
DELETE
/api/v1/sites/{site_id}/zones/{zone_id}
deleteSiteZone
deleteSiteZone 2 params → 200400401403404429
GET
/api/v1/sites/{site_id}/zones/{zone_id}
getSiteZone
getSiteZone 2 params → 200400401403404429
PUT
/api/v1/sites/{site_id}/zones/{zone_id}
updateSiteZone
updateSiteZone 2 params body → 200400401403404429
GET
/api/v1/sites/{site_id}/{zone_type}/count
countSiteZoneSessions
countSiteZoneSessions 11 params → 200400401403404429
GET
/api/v1/sites/{site_id}/{zone_type}/visits/search
searchSiteZoneSessions
searchSiteZoneSessions 12 params → 200400401403404429

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are zone (9 properties), response_count (6 properties), response_zone_search (6 properties), response_zone_search_item (4 properties). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
response_count
object
6 properties 6 required
response_http403
object
1 property
zone_type
string
enum: rssizones, zones
response_zone_search_results
array
count_results
array
zone_vertex
object
2 properties 2 required
response_zone_search
object
6 properties
count_result
object
1 property 1 required
site_id
string
response_http404
object
1 property
response_zone_search_item
object
4 properties
timestamp
number
Epoch (seconds)
modified_time
number
When the object has been modified for the last time, in epoch
response_http400
object
1 property
zones
array
rf_client_type
string
enum: asset, client, sdkclient
zone
object
Zone
9 properties
response_http429
object
1 property
visits_scope
string
enum: map, rssizone, site, zone
zone_vertices
array
Vertices used to define an area. It’s assumed that the last point connects to the first point and forms an closed area
site_zone_count_distinct
string
enum: scope, scopeid, user, usertype
zone_scope
string
enum: map, rssizone, site, zone
response_http401
object
1 property
org_id
string
created_time
number
When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-sites-zones-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