How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mist 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.

Mist Sites Zones API is one of 212 APIs that Mist 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.

This API exposes 7 operations across 4 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 2606.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.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Mist Sites Zones API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

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.

response_http403
object
Standard HTTP 403 permission error response
1 property
site_zone_count_distinct
string
enum: scope, scopeid, user, usertype
org_id
string
Unique identifier of a Mist organization
response_http400
object
Standard HTTP 400 bad request error response
1 property
zone_type
string
Zone collection type, either regular zones or RSSI zones. enum: rssizones, zones
zone_vertex
object
Zone polygon vertex expressed in map pixels
2 properties 2 required
response_zone_search_results
array
Zone visit records returned by search
response_count
object
Distinct count response for time-bounded search results
6 properties 6 required
visits_scope
string
enum: map, rssizone, site, zone
response_zone_search
object
Paginated response for site zone visit search results
6 properties
count_results
array
List of count result rows
timestamp
number
Epoch timestamp, in seconds
modified_time
number
When the object has been modified for the last time, in epoch
count_result
object
Count result row with the matching distinct field values
1 property 1 required
rf_client_type
string
enum: asset, client, sdkclient
response_http404
object
Standard HTTP 404 not found error response
1 property
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
id
string
Unique ID of the object instance in the Mist Organization
site_id
string
Unique identifier of a Mist site
created_time
number
When the object has been created, in epoch
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
response_zone_search_item
object
Zone visit record for a client, asset, or SDK client
4 properties
zone_scope
string
enum: map, rssizone, site, zone
zones
array
Zone records returned by a list response
zone
object
Zone defined on a site map
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-sites-zones-api-openapi.yml Raw ↑

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
Where this information came from

This is an independent, third-party profile of Mist Sites Zones API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.