v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Clients

Get Clients Usage

Retrieves the TX and RX usage trend (sum of bytes) for clients over a time range. Supports filtering through the filter query parameter using timestamp, macAddress, serialNumber, siteId, and siteName. When macAddress is provided, returns usage trend for that specific client. When serialNumber is provided, returns aggregated usage for all clients on that device. When siteId or siteName is provided, returns aggregated usage for all clients at that site. When no filter is provided, returns tenant-level aggregated usage.

Sampling interval is determined by the time range:

≤ 1 day → 5 min
1 day and ≤ 1 month → 3 hours

get/network-monitoring/v1/clients-usage

Query parameters

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields, operators and value format are in the below given table.

Field	Operators	Format
timestamp	gt and lt	Date-time (RFC 3339 timestamp in UTC+0) string
siteId	eq	string
siteName	eq	string
macAddress	eq	string
serialNumber	eq	string

The operators are implemented as follows:

gt: Used to indicate the start of the timestamp range. If timestamp gt is omitted, it defaults to 3 hours before the timestamp lt value. If both timestamp gt and timestamp lt are omitted, the effective start defaults to 3 hours before the current timestamp.
lt: Used to indicate the end of the timestamp range. If timestamp lt is omitted, it defaults to the current timestamp.
For global-level queries, the interval between timestamp gt and timestamp lt must be less than or equal to 7 days. For site-level queries, the interval must be less than or equal to 1 month.
eq: Only values exactly matching the given value are returned.

Response

Response schema for clients usage trend.

keysstring[] required

Fixed keys representing TX and RX byte usage.

interval'5 mins' | '3 hours' required

Sampling interval based on the given timestamp filter range.

typestring const required

The type of the resource.

Example response

{
  "interval": "5 mins",
  "keys": [
    "txUsage",
    "rxUsage"
  ],
  "samples": [
    {
      "data": [
        1048576,
        524288
      ],
      "ts": "2025-08-19T06:45:00Z"
    },
    {
      "data": [
        2097152,
        1048576
      ],
      "ts": "2025-08-19T06:50:00Z"
    }
  ],
  "type": "network-monitoring/client-monitoring"
}