OrgsClientsWired
countOrgWiredClients
Count by Distinct Attributes of Clients
Note: For list of available type values, please refer to List Client Events Definitions
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
Format
uuidQuery Parameters
distinct?string
Field used to group this count response. enum: device_mac, mac, port_id, site_id, type, vlan
Default
"mac"Value in
- "device_mac"
- "mac"
- "port_id"
- "site_id"
- "type"
- "vlan"
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
Range
0 <= valueDefault
100Response Body
curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/wired_clients/count"{ "distinct": "string", "end": 0, "limit": 0, "results": [ { "count": 0, "property": "string" } ], "start": 0, "total": 0}