Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsClientsWireless

countOrgWirelessClientEvents

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

Count wireless client event records across the organization, optionally grouped by event attributes and filtered by event type, WLAN, radio, site, 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: band, channel, proto, ssid, type, wlan_id

Value in

  • "band"
  • "channel"
  • "proto"
  • "ssid"
  • "type"
  • "wlan_id"
type?string

See List Device Events Definitions. Accepts multiple comma-separated values.

reason_code?integer

Reason code filter for association and disassociation events

ssid?string

Filter results by SSID

ap?string

Filter results by AP MAC address

proto?string

802.11 protocol used to filter results. enum: a, ac, ax, b, be, g, n

Value in

  • "a"
  • "ac"
  • "ax"
  • "b"
  • "be"
  • "g"
  • "n"
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"
wlan_id?string

Filter results by WLAN identifier

site_id?string

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

searchOrgWiredClients GET

Search for Wired Clients in org Note: For list of available `type` values, please refer to [List Client Events Definitions](/api/mist/constants/constants-events/listClientEventsDefinitions)

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.