Skip to main content

Query Time Series Application QoS Metrics (v2.0)

POST 

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

Query the time series application QoS metrics.

Request

Body

Filters for application qos metrics

    end_time daterequired

    The end time to get the application QoS metrics.

    filter ApplicationQosMetricsFilterrequired

    Filters according to the specifications.

    application_name stringrequired

    Filter by the name of the application.

    direction stringrequired

    Possible values: [Ingress, Egress]

    Filter by the traffic direction.

    email string[]required

    Filter by the email address.

    site string[]required

    Filter by the site.

    user string[]required

    Filter by user.

    interval stringrequired

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

    The interval time of the application QoS metrics.

    max_datapoints int32required

    The max datapoints of the application QoS metrics.

    metrics Metrics[]required

    Details of the application QoS 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.

  • ]
  • ]
  • name stringrequired

    The name of the Application QoS metric.

    start_time daterequired

    The start time to get the application QoS metrics.

    view Viewrequired

    View the application QoS metrics.

    individual stringrequired

    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 booleanrequired

    The summary of the view.

Responses

Successful Operation

Schema
    metrics Metrics[]required

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