Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesZones

searchSiteZoneSessions

GET
/api/v1/sites/{site_id}/{zone_type}/visits/search

Search Zone Sessions

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
zone_type*string

Zone collection type, either regular zones or RSSI zones. enum: rssizones, zones

Value in

  • "rssizones"
  • "zones"

Query Parameters

user_type?string

Filter results by user type. enum: asset, client, sdkclient

Value in

  • "asset"
  • "client"
  • "sdkclient"
user?string

Client MAC / Asset MAC / SDK UUID

scope_id?string

If scope==map/zone/rssizone, the scope id

scope?string

Filter results by scope. enum: map, rssizone, site, zone

Default"site"

Value in

  • "map"
  • "rssizone"
  • "site"
  • "zone"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
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"
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"
search_after?string

Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/rssizones/visits/search"
{  "end": 1541705289.769911,  "limit": 1,  "next": "/api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/zones/visits/search?limit=2&end=1541705247.000&scope_id=85fbba9e-4e12-11e6-9188-0242ac110007&user_type=asset&start=1541618889.77",  "results": [    {      "enter": 1541705254,      "scope": "map",      "timestamp": 1541705254,      "user": "c4b301c81166"    }  ],  "start": 1541618889.769886,  "total": 5892}

updateSiteZone PUT

Update Site Zone

cloneOrg POST

Create an Org by cloning from another one. Org Settings, Templates, Wxlan Tags, Wxlan Tunnels, Wxlan Rules, Org Wlans will be copied. Sites and Site Groups will not be copied, and therefore, the copied template will not be applied to any site/sitegroups.