Query Network Point Metrics Bandwidth Usage (v2.0)
POST/sdwan/v2.0/api/monitor/network_point_metrics_bw
Query the network point metrics bandwidth usage for all sites across tenants.
Request
- application/json
Body
Query request for getting network point metrics
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
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.
The direction of the traffic.
The element.
The configured interfaces.
The site.
The sites.
The WAN interface of the network.
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.
series Series[]required
Information on the series schema.
data Data[]required
Data
datapoints Datapoints[]required
Datapoints
The date and time of the series.
The filter property ID.
Links
The sites.
The values of the filter.
Statistics
The interval time.
The name.
Unit
View the active series details.
The name of the network point metric. Maz size = 128.
The start time to get the network point metrics. Start times need to be specified in ISO8601 UTC format.
Responses
- 200
- 400
- 500
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
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.
The name of the network point metric. Maz size = 128.
sites PointMetricsSites[]required
The sites.
data PointDatarequired
The data of the point metric sites.
Avail Disk
Avail Mem
Avidle
Avidlemn
Avidlemx
The overall health associated with the path for the observation period.
The downward jitter average associated with a path in milliseconds for the observation period.
The downward mos average associated with the path as a percentage for the observation period.
The downward max mos average associated with the path as a percentage for the observation period.
The downward min mos average associated with the path as a percentage for the observation period.
The downward packet loss average associated with the path as a percentage for the observation period.
Dskmn
Dskmx
Egress
Ingress
The overall health associated with the path for the observation period.
Memmn
Memmx
The RTT latency associated with the path in milliseconds for the observation period.
Sample Completeness
Tunnel Healthscore
The upward jitter associated with the path in milliseconds for the observation period.
The upward MOS associated with the path for the observation period. Value 1 - 5.
The upward max MOS associated with the path for the observation period.
The upward min MOS associated with the path for the observation period.
The upward packet loss average associated with the path as a percentage for the observation period.
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.
anynetlinks PointMetricsAnynet[]required
The details of the anynet links.
The anynet link ID.
data PointDatarequired
The data of the point metric Anynet.
Avail Disk
Avail Mem
Avidle
Avidlemn
Avidlemx
The overall health associated with the path for the observation period.
The downward jitter average associated with a path in milliseconds for the observation period.
The downward mos average associated with the path as a percentage for the observation period.
The downward max mos average associated with the path as a percentage for the observation period.
The downward min mos average associated with the path as a percentage for the observation period.
The downward packet loss average associated with the path as a percentage for the observation period.
Dskmn
Dskmx
Egress
Ingress
The overall health associated with the path for the observation period.
Memmn
Memmx
The RTT latency associated with the path in milliseconds for the observation period.
Sample Completeness
Tunnel Healthscore
The upward jitter associated with the path in milliseconds for the observation period.
The upward MOS associated with the path for the observation period. Value 1 - 5.
The upward max MOS associated with the path for the observation period.
The upward min MOS associated with the path for the observation period.
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
Avail Mem
Avidle
Avidlemn
Avidlemx
The overall health associated with the path for the observation period.
The downward jitter average associated with a path in milliseconds for the observation period.
The downward mos average associated with the path as a percentage for the observation period.
The downward max mos average associated with the path as a percentage for the observation period.
The downward min mos average associated with the path as a percentage for the observation period.
The downward packet loss average associated with the path as a percentage for the observation period.
Dskmn
Dskmx
Egress
Ingress
The overall health associated with the path for the observation period.
Memmn
Memmx
The RTT latency associated with the path in milliseconds for the observation period.
Sample Completeness
Tunnel Healthscore
The upward jitter associated with the path in milliseconds for the observation period.
The upward MOS associated with the path for the observation period. Value 1 - 5.
The upward max MOS associated with the path for the observation period.
The upward min MOS associated with the path for the observation period.
The upward packet loss average associated with the path as a percentage for the observation period.
The WAN path ID.
Unit
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.
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.
The 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-12-06",
"view": {
"individual": "ELEMENT",
"summary": true
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_REQUEST_ERROR_0001"
},
{
"code": "METRIC_NOT_SUPPORTED"
},
{
"code": "METRIC_UNIT_NOT_SUPPORTED"
},
{
"code": "VERSION_NOT_SUPPORTED"
}
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}