v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

Get uplink probe performance trends

Retrieves gateway uplink performance trends for the selected probe based on timestamp range.

get/network-monitoring/v1/gateways/{serial-number}/uplinks/{link-tag}/probes/{probe}/performance-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.

probestring const required

The host IP of the probe. For health check probe, provide the input as 'Health-Check'.

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 performance trends of the uplink probe.

metricstring required

Metric for the uplink performance trend.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

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