Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Access Points

Get throughput trend of an Access Point.

The API retrieves throughput trend data of an access point, 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.

Usage Notes:

  • Provide interface-type of WIRELESS to retrieve aggregated throughput data for radios.

  • Provide interface-type of WIRED to retrieve aggregated throughput data for a wired interface.

  • Provide interface-type of LTE to retrieve throughput data of modem.

get/network-monitoring/v1/aps/{serial-number}/throughput-trends

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Serial number of an access point device.

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.

FieldOperatorsFormat
timestampgt and ltDate-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

interface-type'WIRED' | 'WIRELESS' | 'LTE' required

Interface type of an access point for which the data being requested.

Response

The response object provides throughput trend of an access point.

metricstring const required

Metric for the throughput trend of an access point network or interface.

idstring const required

Primary identifier for the resource.

typestring const required

The type of the resource.

Example response

{
  "metric": "ap_throughput",
  "graph": {
    "keys": [
      "tx",
      "rx"
    ],
    "samples": [
      {
        "data": [
          10,
          12
        ],
        "timestamp": "2022-07-30T20:00:00Z"
      }
    ],
    "samplingIntervalInMinutes": 5
  },
  "id": "AP00000001",
  "type": "network-monitoring/access-point-monitoring"
}