Skip to main content

Query Network Point Metrics Bandwidth Usage (v2.0)​

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

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

    The direction of the traffic.

  • element string[] required

    The element.

  • interface string[] required

    The configured interfaces.

  • site string required

    The site.

  • sites string[] required

    The sites.

  • waninterface string[] required

    The 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 required

    The date and time of the series.

  • filter_property_id string required

    The filter property ID.

  • links string[] required

    Links

  • sites string[] required

    The sites.

  • value number required

    The values of the filter.

  • ]
  • statistics object required

    Statistics

  • ]
  • interval string required

    The interval time.

  • name string required

    The name.

  • unit string required

    Unit

  • view object required

    View 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.

Responses

Successful Operation

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 required

    The 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 required

    Avail Disk

  • avail_mem number required

    Avail Mem

  • avidle number required

    Avidle

  • avidlemn number required

    Avidlemn

  • avidlemx number required

    Avidlemx

  • bad_link_health_reason_bitmap number required

    The overall health associated with the path for the observation period.

  • downlink_jitter_avg number required

    The downward jitter average associated with a path in milliseconds for the observation period.

  • downlink_mos_avg number required

    The downward mos average associated with the path as a percentage for the observation period.

  • downlink_mos_max number required

    The downward max mos average associated with the path as a percentage for the observation period.

  • downlink_mos_min number required

    The downward min mos average associated with the path as a percentage for the observation period.

  • downlink_pkt_loss_avg number required

    The downward packet loss average associated with the path as a percentage for the observation period.

  • dskmn number required

    Dskmn

  • dskmx number required

    Dskmx

  • egress number required

    Egress

  • ingress number required

    Ingress

  • link_healthy number required

    The overall health associated with the path for the observation period.

  • memmn number required

    Memmn

  • memmx number required

    Memmx

  • rtt_latency number required

    The RTT latency associated with the path in milliseconds for the observation period.

  • sample_completeness number required

    Sample Completeness

  • tunnel_healthscore number required

    Tunnel Healthscore

  • uplink_jitter_avg number required

    The upward jitter associated with the path in milliseconds for the observation period.

  • uplink_mos_avg number required

    The upward MOS associated with the path for the observation period. Value 1 - 5.

  • uplink_mos_max number required

    The upward max MOS associated with the path for the observation period.

  • uplink_mos_min number required

    The upward min MOS associated with the path for the observation period.

  • uplink_pkt_loss_avg number required

    The upward packet loss average associated with the path as a percentage for the observation period.

  • site_id string required

    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 string required

    The anynet link ID.

  • data PointData required

    The data of the point metric Anynet.

  • avail_disk number required

    Avail Disk

  • avail_mem number required

    Avail Mem

  • avidle number required

    Avidle

  • avidlemn number required

    Avidlemn

  • avidlemx number required

    Avidlemx

  • bad_link_health_reason_bitmap number required

    The overall health associated with the path for the observation period.

  • downlink_jitter_avg number required

    The downward jitter average associated with a path in milliseconds for the observation period.

  • downlink_mos_avg number required

    The downward mos average associated with the path as a percentage for the observation period.

  • downlink_mos_max number required

    The downward max mos average associated with the path as a percentage for the observation period.

  • downlink_mos_min number required

    The downward min mos average associated with the path as a percentage for the observation period.

  • downlink_pkt_loss_avg number required

    The downward packet loss average associated with the path as a percentage for the observation period.

  • dskmn number required

    Dskmn

  • dskmx number required

    Dskmx

  • egress number required

    Egress

  • ingress number required

    Ingress

  • link_healthy number required

    The overall health associated with the path for the observation period.

  • memmn number required

    Memmn

  • memmx number required

    Memmx

  • rtt_latency number required

    The RTT latency associated with the path in milliseconds for the observation period.

  • sample_completeness number required

    Sample Completeness

  • tunnel_healthscore number required

    Tunnel Healthscore

  • uplink_jitter_avg number required

    The upward jitter associated with the path in milliseconds for the observation period.

  • uplink_mos_avg number required

    The upward MOS associated with the path for the observation period. Value 1 - 5.

  • uplink_mos_max number required

    The upward max MOS associated with the path for the observation period.

  • uplink_mos_min number required

    The upward min MOS associated with the path for the observation period.

  • uplink_pkt_loss_avg number required

    The 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 required

    Avail Disk

  • avail_mem number required

    Avail Mem

  • avidle number required

    Avidle

  • avidlemn number required

    Avidlemn

  • avidlemx number required

    Avidlemx

  • bad_link_health_reason_bitmap number required

    The overall health associated with the path for the observation period.

  • downlink_jitter_avg number required

    The downward jitter average associated with a path in milliseconds for the observation period.

  • downlink_mos_avg number required

    The downward mos average associated with the path as a percentage for the observation period.

  • downlink_mos_max number required

    The downward max mos average associated with the path as a percentage for the observation period.

  • downlink_mos_min number required

    The downward min mos average associated with the path as a percentage for the observation period.

  • downlink_pkt_loss_avg number required

    The downward packet loss average associated with the path as a percentage for the observation period.

  • dskmn number required

    Dskmn

  • dskmx number required

    Dskmx

  • egress number required

    Egress

  • ingress number required

    Ingress

  • link_healthy number required

    The overall health associated with the path for the observation period.

  • memmn number required

    Memmn

  • memmx number required

    Memmx

  • rtt_latency number required

    The RTT latency associated with the path in milliseconds for the observation period.

  • sample_completeness number required

    Sample Completeness

  • tunnel_healthscore number required

    Tunnel Healthscore

  • uplink_jitter_avg number required

    The upward jitter associated with the path in milliseconds for the observation period.

  • uplink_mos_avg number required

    The upward MOS associated with the path for the observation period. Value 1 - 5.

  • uplink_mos_max number required

    The upward max MOS associated with the path for the observation period.

  • uplink_mos_min number required

    The upward min MOS associated with the path for the observation period.

  • uplink_pkt_loss_avg number required

    The upward packet loss average associated with the path as a percentage for the observation period.

  • wn_path_id string required

    The WAN path ID.

  • ]
  • ]
  • unit string required

    Unit

  • ]
  • 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 required

    Possible 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 required

    The summary of the view.

Loading...