---
title: "Get Clients Usage"
method: GET
path: "/network-monitoring/v1/clients-usage"
tags: ["Clients"]
---

# Get Clients Usage

`GET /network-monitoring/v1/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

## Query parameters

- `filter` string, const

## Response `200`

Response schema for clients usage trend.

- GetClientsUsage
  - `keys` string[], required — Fixed keys representing TX and RX byte usage.
  - `samples` DataPoint[], required — List of data samples. Each sample contains [txUsage, rxUsage] in bytes.
    - `data` number[], required — A list of values corresponding to the keys
    - `ts` string, date-time — An RFC 3339 date-time string
  - `interval` '5 mins' | '3 hours', required — Sampling interval based on the given timestamp filter range.
  - `type` string, const, required — The type of the resource.

## Other responses

- `400` — Invalid input received.
- `401` — Unauthorized. Authentication credentials are required or invalid.
- `403` — Forbidden: Access is denied.
- `404` — Not Found error.
- `429` — Too Many Requests. The user has sent too many requests in a given amount of time.
- `500` — Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.net/arubanetworks/apis/authorization.md) · [All operations](https://skmtc.net/arubanetworks/apis/authorization/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arubanetworks/authorization/revisions/74c95058b11f/schema)