Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Get gateway tunnel throughput trend

Retrieves throughput trend data for a gateway tunnel based on specified timestamp range.

get/network-monitoring/v1/gateways/{serial-number}/tunnels/{tunnel-name}/throughput-trends

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

tunnel-namestring required
Example:ap-ipsecmap-00:01:b2:22:02:25

Tunnel ID configured in the gateway.

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.

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

Response

The response object provides throughput trends of a gateway tunnel.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "graph": {
    "keys": [
      "tx",
      "rx"
    ],
    "samples": [
      {
        "data": [
          10,
          50
        ],
        "timestamp": "2022-07-30T20:00:00Z"
      }
    ]
  },
  "id": "GW00000001/tunnels/ap-ipsecmap-00:44:55:66:79:4a",
  "type": "network-monitoring/gateway-monitoring"
}