Skip to main content

Create Interface Stats (v2.0)

POST 

/sdwan/v2.0/api/monitor/agg_bw_stats

Start time, end time, and max datapoints are optional with the following restrictions; at least one of them needs to be specified. All the three can not be specified, as the result is ambiguous. Start time, if not specified, defaults to epoch. End time, if not specified, defaults to now. Limit, if not specified, defaults to None. Start and end times need to be specified in ISO8601 UTC format.

Request

Body

Query request for getting sysmetrics

    end_time date

    The end time to get the system metrics.

    filter AggregateBWStatsFilter

    Filters according to the specifications.

    site string[]

    Site

    interval stringrequired

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

    The interval time.

    max_datapoints int32

    The max datapoints of the system metrics.

    metrics Metrics[]required

    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 name of the system metric.

    start_time date

    The start time to get the system metrics.

    view View

    View the system metrics.

    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[]

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