Skip to main content

Query Probe Monitor Metrics (v2.0)

POST 

/sdwan/v2.0/api/monitor/metrics/probes

Query probe monitor metrics.

Request

Body

Details of monitor metrics query

    end_time date

    The end time to get the monitor metrics.

    filter MonitorMetricsFilter

    Filters according to the specifications.

    anynet_link string[]

    The anynet link ID.

    app string[]

    The app for the metrics.

    direction string

    Possible values: [Ingress, Egress]

    The direction of the traffic.

    element string[]

    The element.

    path string[]

    Path of the filter.

    path_type string[]

    Possible values: [public_direct, public_vpn, private_direct, private_vpn, unknown, servicelink]

    The path type.

    probe_config string[]

    Probe Config

    remote_site string[]

    The remote site.

    site string[]

    The site.

    sprid string

    Sprid

    waninterface string[]

    The WAN interface of the network.

    interval stringrequired

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

    The time period of the monitor metrics query.

    max_datapoints int32

    The max data points.

    metrics Metrics[]required

    The details of the metrics.

  • 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

    max_value_time date-time
    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 description of the monitor metric. Maz size = 128.

    start_time date

    The start time to get the monitor metrics.

    view View

    View the monitor metric details.

    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.

Responses

Successful Operation

Schema
    metrics Metrics[]

    The details of the metrics.

  • 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

    max_value_time date-time
    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.

  • ]
  • ]
Loading...