---
title: "Get the throughput trend for a WLAN."
method: GET
path: "/network-monitoring/v1/wlans/{wlan-name}/throughput-trends"
tags: ["Access Points"]
---

# Get the throughput trend for a WLAN.

`GET /network-monitoring/v1/wlans/{wlan-name}/throughput-trends`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/wlans/{wlan-name}/throughput-trends`
- 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/wlans/:wlan-name/throughput-trends/get.ts> (a function with typed inputs; its response is checked against the schema)

The API retrieves throughput trend data for a specific WLAN, including transmitted(tx) and received(rx) data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.

## Path parameters

- `wlan-name` string, const, required

## Query parameters

- `filter` string, const
- `site-id` string, uuid: Id of a site where devices are associated.
- `site-name` string, const: Name of the Site in which the device is present.

## Response `200`

The response object provides throughput trend of a WLAN.

- WLANThroughputTrend
  - `metric` string, const, required: Metric for the throughput trend of a WLAN.
  - `graph` object, required
    - `keys` string[], required: List of metrics which helps to evaluate the throughput trend of a WLAN.
    - `samples` GraphDataPoint[], required
      - `data` number[], required: A list of values corresponding to the keys
      - `timestamp` string, date-time, required: An RFC 3339 date-time string
    - `samplingIntervalInMinutes` integer, required: **Sampling interval for trend data points (in minutes)** Determined automatically by requested time range: | Time Range | Interval | |-----------------|----------| | ≤ 24 hours | 5 min | | > 24 hours | 180 min |
  - `id` string, const, required: Primary identifier of a WLAN.
  - `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.
- `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)