Query Network Point Metrics Health Score (v2.0)
Query the network point metrics health score for all sites across tenants.
- application/json
Request Body
Query request for getting network point metrics
- end_time date required
The end time of the network point metrics query. End times need to be specified in ISO8601 UTC format.
filter NetworkPointMetricsFilter required
Filters according to the specifications.
direction string[] requiredThe direction of the traffic.
element string[] requiredThe element.
interface string[] requiredThe configured interfaces.
site string requiredThe site.
sites string[] requiredThe sites.
waninterface string[] requiredThe WAN interface of the network.
- interval string required
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-time requiredThe date and time of the series.
filter_property_id string requiredThe filter property ID.
links string[] requiredLinks
sites string[] requiredThe sites.
value number requiredThe values of the filter.
]statistics object requiredStatistics
]interval string requiredThe interval time.
name string requiredThe name.
unit string requiredUnit
view object requiredView the active series details.
]]- name string required
The name of the network point metric. Maz size = 128.
- start_time date required
The start time to get the network point metrics. Start times need to be specified in ISO8601 UTC format.
- 200
- 400
- 500
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- interval string required
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 string requiredThe name of the network point metric. Maz size = 128.
sites PointMetricsSites[] required
The sites.
Array [data PointData required
The data of the point metric sites.
avail_disk number requiredAvail Disk
avail_mem number requiredAvail Mem
avidle number requiredAvidle
avidlemn number requiredAvidlemn
avidlemx number requiredAvidlemx
bad_link_health_reason_bitmap number requiredThe overall health associated with the path for the observation period.
downlink_jitter_avg number requiredThe downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg number requiredThe downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max number requiredThe downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min number requiredThe downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg number requiredThe downward packet loss average associated with the path as a percentage for the observation period.
dskmn number requiredDskmn
dskmx number requiredDskmx
egress number requiredEgress
ingress number requiredIngress
link_healthy number requiredThe overall health associated with the path for the observation period.
memmn number requiredMemmn
memmx number requiredMemmx
rtt_latency number requiredThe RTT latency associated with the path in milliseconds for the observation period.
sample_completeness number requiredSample Completeness
tunnel_healthscore number requiredTunnel Healthscore
uplink_jitter_avg number requiredThe upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg number requiredThe upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max number requiredThe upward max MOS associated with the path for the observation period.
uplink_mos_min number requiredThe upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg number requiredThe upward packet loss average associated with the path as a percentage for the observation period.
site_id string requiredID 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 string requiredThe anynet link ID.
data PointData required
The data of the point metric Anynet.
avail_disk number requiredAvail Disk
avail_mem number requiredAvail Mem
avidle number requiredAvidle
avidlemn number requiredAvidlemn
avidlemx number requiredAvidlemx
bad_link_health_reason_bitmap number requiredThe overall health associated with the path for the observation period.
downlink_jitter_avg number requiredThe downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg number requiredThe downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max number requiredThe downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min number requiredThe downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg number requiredThe downward packet loss average associated with the path as a percentage for the observation period.
dskmn number requiredDskmn
dskmx number requiredDskmx
egress number requiredEgress
ingress number requiredIngress
link_healthy number requiredThe overall health associated with the path for the observation period.
memmn number requiredMemmn
memmx number requiredMemmx
rtt_latency number requiredThe RTT latency associated with the path in milliseconds for the observation period.
sample_completeness number requiredSample Completeness
tunnel_healthscore number requiredTunnel Healthscore
uplink_jitter_avg number requiredThe upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg number requiredThe upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max number requiredThe upward max MOS associated with the path for the observation period.
uplink_mos_min number requiredThe upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg number requiredThe upward packet loss average associated with the path as a percentage for the observation period.
]data PointData required
The data of the point metric WAN paths.
avail_disk number requiredAvail Disk
avail_mem number requiredAvail Mem
avidle number requiredAvidle
avidlemn number requiredAvidlemn
avidlemx number requiredAvidlemx
bad_link_health_reason_bitmap number requiredThe overall health associated with the path for the observation period.
downlink_jitter_avg number requiredThe downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg number requiredThe downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max number requiredThe downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min number requiredThe downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg number requiredThe downward packet loss average associated with the path as a percentage for the observation period.
dskmn number requiredDskmn
dskmx number requiredDskmx
egress number requiredEgress
ingress number requiredIngress
link_healthy number requiredThe overall health associated with the path for the observation period.
memmn number requiredMemmn
memmx number requiredMemmx
rtt_latency number requiredThe RTT latency associated with the path in milliseconds for the observation period.
sample_completeness number requiredSample Completeness
tunnel_healthscore number requiredTunnel Healthscore
uplink_jitter_avg number requiredThe upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg number requiredThe upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max number requiredThe upward max MOS associated with the path for the observation period.
uplink_mos_min number requiredThe upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg number requiredThe upward packet loss average associated with the path as a percentage for the observation period.
wn_path_id string requiredThe WAN path ID.
]]unit string requiredUnit
]- start_time date required
The start time to get the network point metrics. Start times need to be specified in ISO8601 UTC format.
view View required
The individual and summary views.
individual string requiredPossible values: [
ELEMENT
,INTERFACE
,CELLULAR_MODULE
,DIRECTION
,SITE
,APP
,PATH
,PATH_TYPE
,WANINTERFACE
,PRIORITY
,TRAFFIC_TYPE
,COMMON
,CLIENT_MAC_ADDRESS
,None
]The individual view values.
summary boolean requiredThe summary of the view.
{
"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-05-27",
"view": {
"individual": "ELEMENT",
"summary": true
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_REQUEST_ERROR_0001"
},
{
"code": "METRIC_NOT_SUPPORTED"
},
{
"code": "VERSION_NOT_SUPPORTED"
}
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}