Skip to main content

Get Radius Metrics (v2.0)

List the radius metrics of eapol rx and tx messages. The start time, end time, and max datapoints attibutes are optional with at least one of them specified. All three attributes can not be specified, as the result will be ambiguous.

Request Body

Query request for getting aaametrics

  • end_time date required

    The end time to get the client metrics. If not specified, it is default to now. End times need to be specified in ISO8601 UTC format.

  • filter RadiusMetricsFilter required

    Filters according to the specifications.

  • client_mac_address string[] required

    The client mac address.

  • direction string required

    Possible values: [Ingress, Egress]

    The direction of the traffic.

  • element string[] required

    The element.

  • interface string[] required

    The configured interfaces.

  • site string[] required

    The site.

  • interval string required

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

    Interval: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property)

  • max_datapoints int32 required

    The max data points.

  • metrics Metrics[] required

    The details of the radius metrics.

  • Array [
  • series Series[] required

    Information on the series schema.

  • Array [
  • data Data[] required

    Data

  • Array [
  • datapoints Datapoints[] required

    Datapoints

  • Array [
  • duration date-time required

    The date and time of the series.

  • filter_property_id string required

    The filter property ID.

  • links string[] required

    Links

  • sites string[] required

    The sites.

  • value number required

    The values of the filter.

  • ]
  • statistics object required

    Statistics

  • ]
  • interval string required

    The interval time.

  • name string required

    The name.

  • unit string required

    Unit

  • view object required

    View the active series details.

  • ]
  • ]
  • name string required

    The description of the client metrics. Maz size = 128.

  • start_time date required

    The start time to get the client metrics. If not specified, it is default to epoch. Start times need to be specified in ISO8601 UTC format.

  • view View required

    View the active RADIUS server details.

  • individual string required

    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 boolean required

    The summary of the view.

Responses

Successful Operation


Schema
  • metrics Metrics[] required

    The details of the radius metrics.

  • Array [
  • series Series[] required

    Information on the series schema.

  • Array [
  • data Data[] required

    Data

  • Array [
  • datapoints Datapoints[] required

    Datapoints

  • Array [
  • duration date-time required

    The date and time of the series.

  • filter_property_id string required

    The filter property ID.

  • links string[] required

    Links

  • sites string[] required

    The sites.

  • value number required

    The values of the filter.

  • ]
  • statistics object required

    Statistics

  • ]
  • interval string required

    The interval time.

  • name string required

    The name.

  • unit string required

    Unit

  • view object required

    View the active series details.

  • ]
  • ]
Loading...