v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Clients

Get Top N Clients By Usage

Retrieves top N client by usage in reverse sorted order across a time range.

get/network-monitoring/v1/clients-topn-usage

Query parameters

site-idstring const

Example:2778382

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

site-namestring const

Example:site_name1

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

start-atstring const

Example:2025-07-10T08:09:17.419Z

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. The interval between start-at and end-at must be ≤ 1 month. Default is end-at - 3 hours.

end-atstring const

Example:2025-07-10T08:11:17.419Z

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.

serial-numberstring const

Example:QWR124780123

Specifies the device identifier.

limitinteger

Maximum number of clients to be retrieved. Allowed range is 1 to 100.

Response

Response schema for top N clients by usage.

countinteger required

No of clients retrieved

Example response

{
  "count": 3,
  "items": [
    {
      "clientName": "34:1B:9F:BE:40:01",
      "macAddress": "34:1b:9f:be:40:01",
      "usage": 8339422,
      "clientConnectionType": "Wireless",
      "siteName": "Site-1",
      "siteId": 2778382
    },
    {
      "clientName": "D0_94_2A_F8_30_01",
      "macAddress": "d0:94:2a:f8:30:01",
      "usage": 7102255,
      "clientConnectionType": "Wireless",
      "siteName": "Site-2",
      "siteId": "2778383"
    },
    {
      "clientName": "36:6C:11:9D:10:01",
      "macAddress": "36:6c:11:9d:10:01",
      "usage": 6644045,
      "clientConnectionType": "Wired",
      "siteName": "Site-3",
      "siteId": 2778352
    }
  ]
}