v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Clients

Get Clients Trend

Retrieves the clients trend based on the specified group-by field and type category across a time range.

get/network-monitoring/v1/clients-trend

Query parameters

site-idstring const

Example:2778382

The ID of the site for which clients trend are to be retrieved.

site-namestring const

Example:site_name1

The name of the site for which clients trend are to be retrieved.

start-atstring const

Example:2025-08-19T06:45:00Z

Start timestamp in RFC 3339 date-time string. Must be less than end-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, the interval must be ≤ 1 month. Interval between sample data points is based on the time difference:

Less than or equal to 1 day → 5 min
Greater than 1 day and less than or equal to 1 month → 3 hours

end-atstring const

Example:2025-08-19T09:45:00Z

End timestamp in RFC 3339 date-time string. Must be greater than start-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, it must be ≤ 1 month. Default is current timestamp.

Groups results by the specified field. If grouping by role, vlan, or wlan gives more than 5 unique names, then returns top 4 by client count and folds remaining under 'Others' name. wlan, radio, security, protocol supported for wireless clients only.

type'ALL' | 'WIRELESS' | 'WIRED'

Category of clients where group-by field should be applied.

serial-numberstring const

Example:QWR124780123

Specifies the device identifier.

Response

Response schema for client Trends

keysstring[] required

List of categories available for a selected filter

interval'5 mins' | '3 hours' required

Interval based on given start-at and end-at.

typestring const required

The type of the resource.

idstring const required

Primary identifier for the resource.

Example response

{
  "interval": "5 mins",
  "keys": [
    "Wired",
    "Wireless"
  ],
  "samples": [
    {
      "data": [
        2,
        4
      ],
      "ts": "2025-08-29T03:45:00Z"
    },
    {
      "data": [
        2,
        4
      ],
      "ts": "2025-08-29T03:50:00Z"
    }
  ],
  "id": "4fce1e37-9e48-4fb4-bb62-2c11ee6e3d83",
  "type": "network-monitoring/client-monitoring"
}