Skip to main content

Query Qos metrics

POST 

/sdwan/v2.0/api/monitor/qos_metrics

Provides time series data for QOS stats

Request

Body

Details of qos metrics query

    end_time daterequired

    The end time to get the QoS metrics.

    filter QosMetricsFilterrequired

    Filters according to the specifications.

    direction stringrequired

    Possible values: [Ingress, Egress]

    The direction of the traffic.

    element string[]required

    The element.

    priority string[]required

    Priority level set for the QoS metric filter.

    site string[]required

    The sites.

    traffic_type string[]required

    The traffic type for the QoS metric.

    waninterface string[]required

    The WAN interface of the network.

    interval stringrequired

    Possible values: [TEN_SEC, ONE_MIN, FIVE_MIN, ONE_HOUR, ONE_DAY]

    The time period of the QoS query.

    max_datapoints int32required

    The max data points.

    metrics Metrics[]required

    Metrics: Valid ListObject(allowDuplicate = true, allowEmpty = false, allowNull = false, listMaxSize = 0, error = INVALID_FILTER: Schema check failed - Invalid value for param {}, required = true)

  • 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 description of the QoS metric. Maz size = 128.

    start_time daterequired

    The start time to get the QoS metrics.

    view Viewrequired

    View the QoS metric details.

    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.

Responses

Successful Operation

Schema
    metrics Metrics[]required

    The details of the metrics.

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

  • ]
  • ]
Loading...