Query Network Point Metrics Bandwidth Usage (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/monitor/network_point_metrics

Query the network point metrics bandwidth usage for all sites across tenants.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Query request for getting network point metrics

end_time date

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[]

The direction of the traffic.

element string[]

The element.

interface string[]

The configured interfaces.

site string

The site.

sites string[]

The sites.

waninterface string[]

The WAN interface of the network.

interval stringrequired

Possible values: [10sec, 1min, 5min, 1hour, 1day, 1month]

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 [
name stringrequired
Name: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) Pattern(error = INVALID_FILTER: Schema check failed - Invalid value for param {}, regexp = ^[A-Za-z]+$)
statistics string[]required
Statistics: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property)
unit stringrequired
Unit: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) Pattern(error = INVALID_FILTER: Schema check failed - Invalid value for param {}, regexp = ^[A-Za-z]+$)
]
name string

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

start_time date

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 string

Possible values: [10sec, 1min, 5min, 1hour, 1day, 1month]

The interval time.

metrics NetworkPointMetrics[]
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
The name of the network point metric. Maz size = 128.
sites PointMetricsSites[]
The sites.
Array [
data PointData
The data of the point metric sites.
avail_disk number
Avail Disk
avail_mem number
Avail Mem
avidle number
Avidle
avidlemn number
Avidlemn
avidlemx number
Avidlemx
bad_link_health_reason_bitmap number
The overall health associated with the path for the observation period.
downlink_jitter_avg number
The downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg number
The downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max number
The downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min number
The downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg number
The downward packet loss average associated with the path as a percentage for the observation period.
dskmn number
Dskmn
dskmx number
Dskmx
egress number
Egress
ingress number
Ingress
init_failure_percent_avg number
Init Failure Percent Avg
init_failure_percent_max number
Init Failure Percent Max
init_failure_percent_min number
Init Failure Percent Min
jitter_ms_avg number
Jitter Ms Avg
jitter_ms_max number
Jitter Ms Max
jitter_ms_min number
Jitter Ms Min
latency_ms_avg number
Latency Ms Avg
latency_ms_max number
Latency Ms Max
latency_ms_min number
Latency Ms Min
link_healthy number
The overall health associated with the path for the observation period.
memmn number
Memmn
memmx number
Memmx
packet_loss_percent_avg number
Packet Loss Percent Avg
packet_loss_percent_max number
Packet Loss Percent Max
packet_loss_percent_min number
Packet Loss Percent Min
rtt_latency number
The RTT latency associated with the path in milliseconds for the observation period.
sample_completeness number
Sample Completeness
tunnel_healthscore number
Tunnel Healthscore
txn_failure_percent_avg number
Txn Failure Percent Avg
txn_failure_percent_max number
Txn Failure Percent Max
txn_failure_percent_min number
Txn Failure Percent Min
uplink_jitter_avg number
The upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg number
The upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max number
The upward max MOS associated with the path for the observation period.
uplink_mos_min number
The upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg number
The upward packet loss average associated with the path as a percentage for the observation period.
site_id string
ID of the remote site. More details on the site can be retrieved by querying the sites API.
waninterfaces PointMetricsWanPath[]
The WAN interfaces of the network.
Array [
anynetlinks PointMetricsAnynet[]
The details of the anynet links.
Array [
anynet_link_id string
The anynet link ID.
data PointData
The data of the point metric Anynet.
avail_disk number
Avail Disk
avail_mem number
Avail Mem
avidle number
Avidle
avidlemn number
Avidlemn
avidlemx number
Avidlemx
bad_link_health_reason_bitmap number
The overall health associated with the path for the observation period.
downlink_jitter_avg number
The downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg number
The downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max number
The downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min number
The downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg number
The downward packet loss average associated with the path as a percentage for the observation period.
dskmn number
Dskmn
dskmx number
Dskmx
egress number
Egress
ingress number
Ingress
init_failure_percent_avg number
Init Failure Percent Avg
init_failure_percent_max number
Init Failure Percent Max
init_failure_percent_min number
Init Failure Percent Min
jitter_ms_avg number
Jitter Ms Avg
jitter_ms_max number
Jitter Ms Max
jitter_ms_min number
Jitter Ms Min
latency_ms_avg number
Latency Ms Avg
latency_ms_max number
Latency Ms Max
latency_ms_min number
Latency Ms Min
link_healthy number
The overall health associated with the path for the observation period.
memmn number
Memmn
memmx number
Memmx
packet_loss_percent_avg number
Packet Loss Percent Avg
packet_loss_percent_max number
Packet Loss Percent Max
packet_loss_percent_min number
Packet Loss Percent Min
rtt_latency number
The RTT latency associated with the path in milliseconds for the observation period.
sample_completeness number
Sample Completeness
tunnel_healthscore number
Tunnel Healthscore
txn_failure_percent_avg number
Txn Failure Percent Avg
txn_failure_percent_max number
Txn Failure Percent Max
txn_failure_percent_min number
Txn Failure Percent Min
uplink_jitter_avg number
The upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg number
The upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max number
The upward max MOS associated with the path for the observation period.
uplink_mos_min number
The upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg number
The upward packet loss average associated with the path as a percentage for the observation period.
]
data PointData
The data of the point metric WAN paths.
avail_disk number
Avail Disk
avail_mem number
Avail Mem
avidle number
Avidle
avidlemn number
Avidlemn
avidlemx number
Avidlemx
bad_link_health_reason_bitmap number
The overall health associated with the path for the observation period.
downlink_jitter_avg number
The downward jitter average associated with a path in milliseconds for the observation period.
downlink_mos_avg number
The downward mos average associated with the path as a percentage for the observation period.
downlink_mos_max number
The downward max mos average associated with the path as a percentage for the observation period.
downlink_mos_min number
The downward min mos average associated with the path as a percentage for the observation period.
downlink_pkt_loss_avg number
The downward packet loss average associated with the path as a percentage for the observation period.
dskmn number
Dskmn
dskmx number
Dskmx
egress number
Egress
ingress number
Ingress
init_failure_percent_avg number
Init Failure Percent Avg
init_failure_percent_max number
Init Failure Percent Max
init_failure_percent_min number
Init Failure Percent Min
jitter_ms_avg number
Jitter Ms Avg
jitter_ms_max number
Jitter Ms Max
jitter_ms_min number
Jitter Ms Min
latency_ms_avg number
Latency Ms Avg
latency_ms_max number
Latency Ms Max
latency_ms_min number
Latency Ms Min
link_healthy number
The overall health associated with the path for the observation period.
memmn number
Memmn
memmx number
Memmx
packet_loss_percent_avg number
Packet Loss Percent Avg
packet_loss_percent_max number
Packet Loss Percent Max
packet_loss_percent_min number
Packet Loss Percent Min
rtt_latency number
The RTT latency associated with the path in milliseconds for the observation period.
sample_completeness number
Sample Completeness
tunnel_healthscore number
Tunnel Healthscore
txn_failure_percent_avg number
Txn Failure Percent Avg
txn_failure_percent_max number
Txn Failure Percent Max
txn_failure_percent_min number
Txn Failure Percent Min
uplink_jitter_avg number
The upward jitter associated with the path in milliseconds for the observation period.
uplink_mos_avg number
The upward MOS associated with the path for the observation period. Value 1 - 5.
uplink_mos_max number
The upward max MOS associated with the path for the observation period.
uplink_mos_min number
The upward min MOS associated with the path for the observation period.
uplink_pkt_loss_avg number
The upward packet loss average associated with the path as a percentage for the observation period.
wn_path_id string
The WAN path ID.
]
]
unit string
Unit
]
start_time date

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

view View

The individual and summary views.

individual string

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 boolean

The summary of the view.

Example (from schema)

{
  "interval": "10sec",
  "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,
            "init_failure_percent_avg": 0,
            "init_failure_percent_max": 0,
            "init_failure_percent_min": 0,
            "jitter_ms_avg": 0,
            "jitter_ms_max": 0,
            "jitter_ms_min": 0,
            "latency_ms_avg": 0,
            "latency_ms_max": 0,
            "latency_ms_min": 0,
            "link_healthy": 0,
            "memmn": 0,
            "memmx": 0,
            "packet_loss_percent_avg": 0,
            "packet_loss_percent_max": 0,
            "packet_loss_percent_min": 0,
            "rtt_latency": 0,
            "sample_completeness": 0,
            "tunnel_healthscore": 0,
            "txn_failure_percent_avg": 0,
            "txn_failure_percent_max": 0,
            "txn_failure_percent_min": 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,
                    "init_failure_percent_avg": 0,
                    "init_failure_percent_max": 0,
                    "init_failure_percent_min": 0,
                    "jitter_ms_avg": 0,
                    "jitter_ms_max": 0,
                    "jitter_ms_min": 0,
                    "latency_ms_avg": 0,
                    "latency_ms_max": 0,
                    "latency_ms_min": 0,
                    "link_healthy": 0,
                    "memmn": 0,
                    "memmx": 0,
                    "packet_loss_percent_avg": 0,
                    "packet_loss_percent_max": 0,
                    "packet_loss_percent_min": 0,
                    "rtt_latency": 0,
                    "sample_completeness": 0,
                    "tunnel_healthscore": 0,
                    "txn_failure_percent_avg": 0,
                    "txn_failure_percent_max": 0,
                    "txn_failure_percent_min": 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,
                "init_failure_percent_avg": 0,
                "init_failure_percent_max": 0,
                "init_failure_percent_min": 0,
                "jitter_ms_avg": 0,
                "jitter_ms_max": 0,
                "jitter_ms_min": 0,
                "latency_ms_avg": 0,
                "latency_ms_max": 0,
                "latency_ms_min": 0,
                "link_healthy": 0,
                "memmn": 0,
                "memmx": 0,
                "packet_loss_percent_avg": 0,
                "packet_loss_percent_max": 0,
                "packet_loss_percent_min": 0,
                "rtt_latency": 0,
                "sample_completeness": 0,
                "tunnel_healthscore": 0,
                "txn_failure_percent_avg": 0,
                "txn_failure_percent_max": 0,
                "txn_failure_percent_min": 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": "2024-07-29",
  "view": {
    "individual": "ELEMENT",
    "summary": true
  }
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

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

Example

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

500

Internal Server Error

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

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

Loading...