Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Access Points

Get Access Point Port Collision Error

This API retrieves detailed information about a specific port frame trends of an access point linked to a particular site. It provides key metrics such as Collision Errors and Percentage for a given port index.

get/network-monitoring/v1/aps/{serial-number}/ports/{port-index}/collisions-trends

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Serial number of an access point device.

port-indexstring const required

The access point port number.

Example:1

The port index of 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.

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

Response

The response object contains transmission trend data for Collisions and percentage for a port of an access point.

metricstring const required

Metric for the Collisions trends of an access point port.

idstring const required

Primary identifier of a port under an access point.

typestring const required

The type of the resource.

Example response

{
  "metric": "collision",
  "graph": {
    "keys": [
      "collision",
      "collision_percentage"
    ],
    "samples": [
      {
        "data": [
          1,
          50
        ],
        "timestamp": "2022-07-30T20:00:00Z"
      }
    ],
    "samplingIntervalInMinutes": 5
  },
  "id": "AP00000001/ports/0",
  "type": "network-monitoring/access-point-monitoring"
}