Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesClientsWan

countSiteWanClients

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

Count WAN clients for a site, optionally grouped by the distinct field and filtered by time range. Use Count Org WAN Clients to count WAN 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: hostname, ip, mac, mfg

Default"mac"

Value in

  • "hostname"
  • "ip"
  • "mac"
  • "mfg"
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/wan_clients/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}

countSiteWanClientEvents GET

Count WAN client events for a site, optionally grouped by the `distinct` field and filtered by event type and time range. Use [Count Org WAN Client Events](/api/mist/orgs/orgs-clients/orgs-clients---wan/countOrgWanClientEvents) to count WAN client events across the organization.

searchSiteWanClientEvents GET

Search WAN client events for a site with filters for client identity, manufacturer, NAC rule, event type, and time range. Use [Search Org WAN Client Events](/api/mist/orgs/orgs-clients/orgs-clients---wan/searchOrgWanClientEvents) to search WAN client events across the organization.