Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsClientsWireless

countOrgWirelessClients

GET
/api/v1/orgs/{org_id}/clients/count

Count wireless client records across the organization, optionally grouped by distinct and filtered by client identity, AP, SSID, VLAN, IP, and time range.

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

org_id*string
Formatuuid

Query Parameters

distinct?string

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

Default"device"

Value in

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

Partial / full Client MAC address. Use prefix* for prefix search or *substring* for contains search (e.g. aabbcc* and *bbcc* match aabbccddeeff). Suffix-only wildcards (e.g. *bccddeeff) are not supported. Accepts multiple comma-separated values.

hostname?string

Partial / full Client hostname. Use prefix* for prefix search or *substring* for contains search (e.g. everest* and *rest* match my-everest-client). Suffix-only wildcards (e.g. *everest) are not supported. Accepts multiple comma-separated values.

device?string

Filter results by device type

os?string

Filter results by operating system

model?string

Filter results by device model

ap?string

Filter results by AP MAC address

vlan?string

Filter results by VLAN ID

ssid?string

Filter results by SSID

ip?string

Filter results by IPv4 address

Formatipv4
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/orgs/000000ab-00ab-00ab-00ab-0000000000ab/clients/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}

countOrgWirelessClientEvents GET

Count wireless client event records across the organization, optionally grouped by event attributes and filtered by event type, WLAN, radio, site, and time range.

countOrgWirelessClientsSessions GET

Count historical wireless client sessions across the organization, optionally grouped by `distinct` and filtered by AP, band, client attributes, SSID, WLAN, and time range.