v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

Get gateway port frames packets trend

Retrieves gateway port frame packets trend data for the specified port based on timestamp range.

get/network-monitoring/v1/gateways/{serial-number}/ports/{port-number}/frames-packets-trends

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

port-numberstring required

Example:2

Port number that represents the physical port of the gateway interface (GE 0/0/{port-number}).

Query parameters

filterstring

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 gateway-related information is requested.

Response

The response object provides the data of the packets processed in broadcast and multicast.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "graph": {
    "keys": [
      "broadcast",
      "broadcastPercentage",
      "multicast",
      "multicastPercentage"
    ],
    "samples": [
      {
        "data": [
          187,
          0.03,
          1815,
          0.03
        ],
        "timestamp": "2022-07-30T20:00:00Z"
      }
    ]
  },
  "id": "gw1/ports/GE 0/0/1/frames-packets-trends",
  "type": "network-monitoring/gateway-monitoring"
}