Skip to main content

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

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

Successful Operation

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, None]

    The individual view values.

    summary booleanrequired

    The summary of the view.

Loading...