v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

Get WAN availability trends of gateway uplink

Retrieves WAN availability trends for the specified gateway uplink based on timestamp range.

get/network-monitoring/v1/gateways/{serial-number}/uplinks/{link-tag}/wan-availability-trends

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

link-tagstring required

Example:Airtel

Name of the uplink interface.

Query parameters

site-idstring uuid

Id of a site where devices are associated.

Example:24833497

ID of the site for which gateway-related information is requested.

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.

Response

The response object provides WAN availability trends of the specified gateway uplink.

metricstring required

Metric to evaluate WAN availability of an uplink.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "metric": "default_gateway",
  "graph": {
    "keys": [
      "default_gateway"
    ],
    "samples": [
      {
        "timestamp": "2024-03-12T07:20:50.52Z"
      }
    ]
  },
  "id": "GW00000001",
  "type": "network-monitoring/gateway-monitoring"
}