Skip to main content

Query Probe Point Metrics (v2.0)

POST 

/sdwan/v2.0/api/monitor/probe_point_metrics

Get link quality point metrics for Probe Latency, Jitter, PktLoss, Init Failure, and Txn Failure.

Request

Body

Query request for getting probe point metrics

    end_time date

    The end time of the point metrics query. End times need to be specified in ISO8601 UTC format.

    filter Filter

    Filters according to the specifications.

    elements string[]

    Elements of the filter.

    path string[]

    Path of the filter.

    site object

    Site of the filter.

    type string

    Type of the filter.

    wn_path string[]

    Wn Path

    interval string

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

    The interval time.

    metrics Metrics[]

    The details of the 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

    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 name of the point metric. Maz size = 128.

    start_time date

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

    view View

    View

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

    The time period of the query interval.

    metrics object

    The details of the point metric. Metrics need to specified according to 2.0 specifications. Invalid metrics will be ignored and the result will not include them.

    start_time date

    The start time to get the 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...