Query Network Point Metrics Health Score (v2.0)

POST 
/sdwan/v2.0/api/monitor/network_point_metrics_hs

Query the network point metrics health score for all sites across tenants.

Request

application/json

Body

Query request for getting network point metrics

end_time daterequired

The end time of the network point metrics query. End times need to be specified in ISO8601 UTC format.

filter NetworkPointMetricsFilterrequired

Filters according to the specifications.

direction string[]required

The direction of the traffic.

element string[]required

The element.

interface string[]required

The configured interfaces.

site stringrequired

The site.

sites string[]required

The sites.

waninterface string[]required

The WAN interface of the network.

interval stringrequired

Possible values: [TEN_SEC, ONE_MIN, FIVE_MIN, ONE_HOUR, ONE_DAY]

The interval time.

metrics Metrics[]required
The details of the network point metric. Metrics need to specified according to 2.0 specifications. Invalid metrics will be ignored and the result will not include them.
Array [
series Series[]required
Information on the series schema.
Array [
data Data[]required
Data
Array [
datapoints Datapoints[]required
Datapoints
Array [
duration date-timerequired
The date and time of the series.
filter_property_id stringrequired
The filter property ID.
links string[]required
Links
sites string[]required
The sites.
value numberrequired
The values of the filter.
]
statistics objectrequired
Statistics
]
interval stringrequired
The interval time.
name stringrequired
The name.
unit stringrequired
Unit
view objectrequired
View the active series details.
]
]
name stringrequired

The name of the network point metric. Maz size = 128.

start_time daterequired

The start time to get the network point metrics. Start times need to be specified in ISO8601 UTC format.

Responses

200

Successful Operation

application/json

Schema

Schema

interval stringrequired

Possible values: [TEN_SEC, ONE_MIN, FIVE_MIN, ONE_HOUR, ONE_DAY]

The interval time.

metrics NetworkPointMetrics[]required
The details of the network point metric. Metrics need to specified according to 2.0 specifications. Invalid metrics will be ignored and the result will not include them.
Array [
name stringrequired
The name of the network point metric. Maz size = 128.
sites PointMetricsSites[]required
The sites.
Array [
data PointDatarequired
The data of the point metric sites.
avail_disk numberrequired
Avail Disk
avail_mem numberrequired
Avail Mem
avidle numberrequired
Avidle
avidlemn numberrequired
Avidlemn
avidlemx numberrequired
Avidlemx
bad_link_health_reason_bitmap numberrequired
The overall health associated with the path for the observation period.
downlink_jitter_avg numberrequired
The downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg numberrequired
The downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max numberrequired
The downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min numberrequired
The downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg numberrequired
The downward packet loss average associated with the path as a percentage for the observation period.
dskmn numberrequired
Dskmn
dskmx numberrequired
Dskmx
egress numberrequired
Egress
ingress numberrequired
Ingress
link_healthy numberrequired
The overall health associated with the path for the observation period.
memmn numberrequired
Memmn
memmx numberrequired
Memmx
rtt_latency numberrequired
The RTT latency associated with the path in milliseconds for the observation period.
sample_completeness numberrequired
Sample Completeness
tunnel_healthscore numberrequired
Tunnel Healthscore
uplink_jitter_avg numberrequired
The upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg numberrequired
The upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max numberrequired
The upward max MOS associated with the path for the observation period.
uplink_mos_min numberrequired
The upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg numberrequired
The upward packet loss average associated with the path as a percentage for the observation period.
site_id stringrequired
ID of the remote site. More details on the site can be retrieved by querying the sites API.
waninterfaces PointMetricsWanPath[]required
The WAN interfaces of the network.
Array [
anynetlinks PointMetricsAnynet[]required
The details of the anynet links.
Array [
anynet_link_id stringrequired
The anynet link ID.
data PointDatarequired
The data of the point metric Anynet.
avail_disk numberrequired
Avail Disk
avail_mem numberrequired
Avail Mem
avidle numberrequired
Avidle
avidlemn numberrequired
Avidlemn
avidlemx numberrequired
Avidlemx
bad_link_health_reason_bitmap numberrequired
The overall health associated with the path for the observation period.
downlink_jitter_avg numberrequired
The downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg numberrequired
The downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max numberrequired
The downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min numberrequired
The downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg numberrequired
The downward packet loss average associated with the path as a percentage for the observation period.
dskmn numberrequired
Dskmn
dskmx numberrequired
Dskmx
egress numberrequired
Egress
ingress numberrequired
Ingress
link_healthy numberrequired
The overall health associated with the path for the observation period.
memmn numberrequired
Memmn
memmx numberrequired
Memmx
rtt_latency numberrequired
The RTT latency associated with the path in milliseconds for the observation period.
sample_completeness numberrequired
Sample Completeness
tunnel_healthscore numberrequired
Tunnel Healthscore
uplink_jitter_avg numberrequired
The upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg numberrequired
The upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max numberrequired
The upward max MOS associated with the path for the observation period.
uplink_mos_min numberrequired
The upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg numberrequired
The upward packet loss average associated with the path as a percentage for the observation period.
]
data PointDatarequired
The data of the point metric WAN paths.
avail_disk numberrequired
Avail Disk
avail_mem numberrequired
Avail Mem
avidle numberrequired
Avidle
avidlemn numberrequired
Avidlemn
avidlemx numberrequired
Avidlemx
bad_link_health_reason_bitmap numberrequired
The overall health associated with the path for the observation period.
downlink_jitter_avg numberrequired
The downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg numberrequired
The downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max numberrequired
The downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min numberrequired
The downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg numberrequired
The downward packet loss average associated with the path as a percentage for the observation period.
dskmn numberrequired
Dskmn
dskmx numberrequired
Dskmx
egress numberrequired
Egress
ingress numberrequired
Ingress
link_healthy numberrequired
The overall health associated with the path for the observation period.
memmn numberrequired
Memmn
memmx numberrequired
Memmx
rtt_latency numberrequired
The RTT latency associated with the path in milliseconds for the observation period.
sample_completeness numberrequired
Sample Completeness
tunnel_healthscore numberrequired
Tunnel Healthscore
uplink_jitter_avg numberrequired
The upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg numberrequired
The upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max numberrequired
The upward max MOS associated with the path for the observation period.
uplink_mos_min numberrequired
The upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg numberrequired
The upward packet loss average associated with the path as a percentage for the observation period.
wn_path_id stringrequired
The WAN path ID.
]
]
unit stringrequired
Unit
]
start_time daterequired

The start time to get the network point metrics. Start times need to be specified in ISO8601 UTC format.

view Viewrequired

The individual and summary views.

individual stringrequired

Possible values: [ELEMENT, INTERFACE, CELLULAR_MODULE, DIRECTION, SITE, APP, PATH, PATH_TYPE, WANINTERFACE, PRIORITY, TRAFFIC_TYPE, COMMON, CLIENT_MAC_ADDRESS, USER, USER_EMAIL, RESOLUTION_QUALITY, None]

The individual view values.

summary booleanrequired

The summary of the view.

Example (from schema)

{
  "interval": "TEN_SEC",
  "metrics": [
    {
      "name": "string",
      "sites": [
        {
          "data": {
            "avail_disk": 0,
            "avail_mem": 0,
            "avidle": 0,
            "avidlemn": 0,
            "avidlemx": 0,
            "bad_link_health_reason_bitmap": 0,
            "downlink_jitter_avg": 0,
            "downlink_mos_avg": 0,
            "downlink_mos_max": 0,
            "downlink_mos_min": 0,
            "downlink_pkt_loss_avg": 0,
            "dskmn": 0,
            "dskmx": 0,
            "egress": 0,
            "ingress": 0,
            "link_healthy": 0,
            "memmn": 0,
            "memmx": 0,
            "rtt_latency": 0,
            "sample_completeness": 0,
            "tunnel_healthscore": 0,
            "uplink_jitter_avg": 0,
            "uplink_mos_avg": 0,
            "uplink_mos_max": 0,
            "uplink_mos_min": 0,
            "uplink_pkt_loss_avg": 0
          },
          "site_id": "string",
          "waninterfaces": [
            {
              "anynetlinks": [
                {
                  "anynet_link_id": "string",
                  "data": {
                    "avail_disk": 0,
                    "avail_mem": 0,
                    "avidle": 0,
                    "avidlemn": 0,
                    "avidlemx": 0,
                    "bad_link_health_reason_bitmap": 0,
                    "downlink_jitter_avg": 0,
                    "downlink_mos_avg": 0,
                    "downlink_mos_max": 0,
                    "downlink_mos_min": 0,
                    "downlink_pkt_loss_avg": 0,
                    "dskmn": 0,
                    "dskmx": 0,
                    "egress": 0,
                    "ingress": 0,
                    "link_healthy": 0,
                    "memmn": 0,
                    "memmx": 0,
                    "rtt_latency": 0,
                    "sample_completeness": 0,
                    "tunnel_healthscore": 0,
                    "uplink_jitter_avg": 0,
                    "uplink_mos_avg": 0,
                    "uplink_mos_max": 0,
                    "uplink_mos_min": 0,
                    "uplink_pkt_loss_avg": 0
                  }
                }
              ],
              "data": {
                "avail_disk": 0,
                "avail_mem": 0,
                "avidle": 0,
                "avidlemn": 0,
                "avidlemx": 0,
                "bad_link_health_reason_bitmap": 0,
                "downlink_jitter_avg": 0,
                "downlink_mos_avg": 0,
                "downlink_mos_max": 0,
                "downlink_mos_min": 0,
                "downlink_pkt_loss_avg": 0,
                "dskmn": 0,
                "dskmx": 0,
                "egress": 0,
                "ingress": 0,
                "link_healthy": 0,
                "memmn": 0,
                "memmx": 0,
                "rtt_latency": 0,
                "sample_completeness": 0,
                "tunnel_healthscore": 0,
                "uplink_jitter_avg": 0,
                "uplink_mos_avg": 0,
                "uplink_mos_max": 0,
                "uplink_mos_min": 0,
                "uplink_pkt_loss_avg": 0
              },
              "wn_path_id": "string"
            }
          ]
        }
      ],
      "unit": "string"
    }
  ],
  "start_time": "2023-12-06",
  "view": {
    "individual": "ELEMENT",
    "summary": true
  }
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "METRIC_NOT_SUPPORTED"
      },
      {
        "code": "VERSION_NOT_SUPPORTED"
      }
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Loading...