v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Access Points

Get channel utilization information for a radio

The API retrieves radio channel utilization data for a specified radio of an access point, including percentages for Transmitting (tx), Receiving (rx), and Non-Wi-Fi interference. It provides insights into how effectively radio channels are being utilized. The data will be fetched based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.

get/network-monitoring/v1/aps/{serial-number}/radios/{radio-number}/channel-utilization-trends

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Serial number of an access point device.

radio-numberstring required

Example:0

radio number within an access point.

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

The operators are implemented as follows:

gt: Used to indicate the start of the timestamp range.
lt: Used to indicate the end of the timestamp range.

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

Response

The response object contains data on radio channel utilization, including percentages for Transmitting (tx), Receiving (rx), and Non-Wi-Fi interference, providing insights into how effectively radio channels are being utilized.

metricstring const required

Performance metric for the channel utilization of an access point radio.

idstring const required

Primary identifier for a radio under an access point.

typestring const required

The type of the resource.

Example response

{
  "metric": "channel_utilization",
  "graph": {
    "keys": [
      "tx",
      "rx",
      "non_wifi_interference"
    ],
    "samples": [
      {
        "data": [
          4,
          35,
          40
        ],
        "timestamp": "2022-07-30T20:00:00Z"
      }
    ],
    "samplingIntervalInMinutes": 5
  },
  "id": "AP00000001/radios/0",
  "type": "network-monitoring/access-point-monitoring"
}