Skip to main content

Query Network Point Metrics Bandwidth Usage (v2.0)

POST 

/v2.0/api/tenants/:tenant_id/monitor/network_point_metrics_bw

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

Request

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

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]

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

    Information on the series schema.

  • Array [
  • data Data[]

    Data

  • Array [
  • datapoints Datapoints[]

    Datapoints

  • Array [
  • duration date-time

    The date and time of the series.

    filter_property_id string

    The filter property ID.

    links string[]

    Links

    ninetieth_percentile number

    Ninetieth Percentile

    sites string[]

    The sites.

    value number

    The values of the filter.

  • ]
  • statistics object

    Statistics

  • ]
  • interval string

    The interval time.

    name string

    The name.

    unit string

    Unit

    view object

    View the active series details.

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

Successful Operation

Schema
    interval string

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

    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

    link_healthy number

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

    memmn number

    Memmn

    memmx number

    Memmx

    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

    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

    link_healthy number

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

    memmn number

    Memmn

    memmx number

    Memmx

    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

    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

    link_healthy number

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

    memmn number

    Memmn

    memmx number

    Memmx

    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

    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.

Loading...