SitesZones

countSiteZoneSessions

GET
/api/v1/sites/{site_id}/{zone_type}/count

Count by Distinct Attributes of Site 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

distinct?string

Field used to group this count response. enum: scope, scope_id, user, user_type

Default"scope_id"

Value in

  • "scope"
  • "scope_id"
  • "user"
  • "user_type"
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"
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"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/rssizones/count?distinct=scope_id"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}