v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Access Points

Get high total bandwidth usage Access Points

The API will retrieve a list of the top access points ranked by their combined bandwidth usage of wired & wireless, sorted in descending order, for a specified site and time period.

get/network-monitoring/v1/top-aps-by-usage

Query parameters

site-idstring uuid

Id of a site where devices are associated.

Example:24833497

ID of the Site for which access point related information is requested

site-namestring const

Name of the Site in which the device is present.

Example:Site1

Name of the Site for which access point related information is requested

limitinteger

Example:20

Specifies the maximum number of top access points returned in the response. The default value is 10.

start-atstring date-time

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Data that is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC+0 timezone. The difference between end-at and start-at should be less than 30 days.

end-atstring date-time

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Data that is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC+0 timezone. The timestamp must be earlier than the current time and later than the start time.It should be earlier than the current time and later than the start-at.

Response

A list of access point (AP) serial numbers along with their respective bandwidth usage. The list is sorted in descending order based on bandwidth usage. If there is no data, an empty list will be returned.

countinteger required

Number of items in the response

Example response

{
  "items": [
    {
      "serialNumber": "AP00000001",
      "deviceName": "ap_1",
      "totalValue": 118800.6,
      "units": "Bytes",
      "id": "AP00000001",
      "type": "network-monitoring/access-point-monitoring"
    }
  ],
  "count": 1
}