Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsClientsWireless

countOrgWirelessClientsSessions

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

Count historical wireless client sessions across the organization, optionally grouped by distinct and filtered by AP, band, client attributes, SSID, WLAN, 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, model, os, ssid, vlan

Default"device"

Value in

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

Filter results by AP MAC address

band?string

802.11 band used to filter radio results. enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable

Value in

  • "24"
  • "5"
  • "5-dedicated"
  • "5-selectable"
  • "6"
  • "6-dedicated"
  • "6-selectable"
client_family?string

E.g. "Mac", "iPhone", "Apple watch"

client_manufacture?string

Filter results by client manufacturer, e.g. "Apple"

client_model?string

Filter results by client model, e.g. "8+", "XS"

client_os?string

E.g. "Mojave", "Windows 10", "Linux"

ssid?string

Filter results by SSID

wlan_id?string

Filter results by WLAN identifier

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

countOrgWirelessClients GET

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

searchOrgWirelessClientEvents GET

Search wireless client event records across the organization with filters for event type, reason code, SSID, AP, key management, protocol, band, WLAN, NAC rule, and time range.