Skip to main content

Query Monitor Metrics (v2.3)

POST 

/sdwan/v2.3/api/monitor/metrics

Query all the monitor metrics.

Request

Body

Details of monitor metrics query

    end_time daterequired

    The end time to get the monitor metrics.

    filter MonitorMetricsFilterrequired

    Filters according to the specifications.

    anynet_link string[]required

    The anynet link ID.

    app string[]required

    The app for the metrics.

    direction stringrequired

    Possible values: [Ingress, Egress]

    The direction of the traffic.

    element string[]required

    The element.

    path string[]required

    Path of the filter.

    path_type string[]required

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

    The path type.

    remote_site string[]required

    The remote site.

    site string[]required

    The site.

    sprid stringrequired

    Sprid

    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 monitor metrics query.

    max_datapoints int32required

    The max data points.

    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.

  • ]
  • ]
  • name stringrequired

    The description of the monitor metric. Maz size = 128.

    start_time daterequired

    The start time to get the monitor metrics.

    view Viewrequired

    View the monitor metric details.

    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

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