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

# Get Top N Clients By Usage

`GET /network-monitoring/v1/clients-topn-usage`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/clients-topn-usage`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-monitoring/v1/clients-topn-usage/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `site-id` string, const
- `site-name` string, const
- `start-at` string, const
- `end-at` string, const
- `serial-number` string, const
- `limit` integer

## Response `200`

Response schema for top N clients by usage.

- GetTopNClientsByUsageResponse: Response containing list of top N clients by usage
  - `items` object[], required: Array of top N clients by usage
    - `clientName` string, required: Name of the client
    - `macAddress` string, required: MAC address of the client
    - `usage` integer, required: Total usage in Bytes
    - `clientConnectionType` 'Wired' | 'Wireless', required: Specifies the type of client
    - `siteName` string, required: The name of the site where the client is located.
    - `siteId` string, required: A unique identifier for the site where the client is located.
    - `type` string, const, required: The type of the resource.
    - `id` string, const, required: Primary identifier for the resource.
  - `count` integer, required: No of clients retrieved

## Other responses

- `400`: Invalid input received.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `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.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)