Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesClientsWireless

countSiteWirelessClients

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

Count wireless clients for a site, optionally grouped by the distinct field and filtered by client attributes and time range. Use Count Org Wireless Clients to count wireless clients across the organization.

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

Query Parameters

distinct?string

Field used to group this count response. enum: ap, device, hostname, ip, model, os, ssid, vlan

Default"device"

Value in

  • "ap"
  • "device"
  • "hostname"
  • "ip"
  • "model"
  • "os"
  • "ssid"
  • "vlan"
ssid?string

Filter results by SSID

ap?string

Filter results by AP MAC address

ip?string

Filter results by IPv4 address

Formatipv4
vlan?string

Filter client results by VLAN ID

hostname?string

Filter results by hostname

os?string

Filter client results by operating system

model?string

Filter results by device model

device?string

Filter client results by device type

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/clients/count?distinct=hostname"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}

countSiteWirelessClientSessions GET

Count wireless client sessions for a site, optionally grouped by the `distinct` field and filtered by AP, SSID, WLAN, client attributes, and time range. Use [Count Org Wireless Client Sessions](/api/mist/orgs/orgs-clients/orgs-clients---wireless/countOrgWirelessClientsSessions) to count wireless client sessions across the organization.

getSiteEventsForClient GET

Get the list of events for a specific client