SitesClientsWired

countSiteWiredClients

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

Count wired clients for a site, optionally grouped by the distinct field and filtered by MAC address, switch port, VLAN, and time range. Use Count Org Wired Clients to count wired 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: mac, port_id, vlan

Default"mac"

Value in

  • "mac"
  • "port_id"
  • "vlan"
mac?string

Filter results by MAC address

device_mac?string

Filter results by device MAC address

port_id?string

Filter results by port identifier

vlan?string

Filter results by VLAN ID

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