get_clients_trend
Retrieve client count trends over time, grouped by type, role, or VLAN. Use it to monitor usage patterns and plan capacity.
Instructions
Get client count trend over time, grouped by a chosen dimension.
Useful for capacity planning and usage pattern analysis.
Args: site_id: Filter by site ID. Empty for all. site_name: Filter by site name. Empty for all. start_at: Start time in RFC 3339 format (max 1 month range). Must not be in the future. end_at: End time in RFC 3339 format. Must not be in the future. group_by: Dimension to group by. Supported values: - Any client_type: TYPE, ROLE, VLAN - WIRELESS only: WLAN, RADIO, SECURITY, PROTOCOL Default is TYPE. client_type: Client category: ALL, WIRELESS, or WIRED. Default is ALL. Must be WIRELESS when group_by is WLAN, RADIO, SECURITY, or PROTOCOL (the API returns 400 otherwise).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_at | No | ||
| site_id | No | ||
| group_by | No | TYPE | |
| start_at | No | ||
| site_name | No | ||
| client_type | No | ALL |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |