Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET HistoricalClientStats

Represents client statistics collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by client or time.

Since Product Version: 1.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v3/data/HistoricalClientStats

Unmodified

This resource has not been modified since the previous API version.

Deprecated

This version has been deprecated. Please use v4.

Response Parameters

Attribute Description

bytesReceived long

Number of bytes received during the session

bytesSent long

Number of bytes sent during the session

collectionTime long

The time collection of this record was finished, measured in milliseconds since the Unix epoch.

dataRate float

Reading data rate, measured in Mbps.

dataRetries long

Number data retries during the session

macAddress String

Client MAC address

packetsReceived long

Number packets received during the session

packetsSent long

Number of packets sent during the session

raPacketsDropped long

Number of IPv6 RA packets dropped during the session

rssi int

The Received Signal Strength Indicator as detected by the access point with which the client is associated, measured in dBm.

rtsRetries long

Number of RTS retries during the session

rxBytesDropped long

Number of Rx bytes dropped during the session

rxPacketsDropped long

Number of Rx packets dropped during the session

snr int

Signal-to-noise ratio of the client session as detected by the access point with which the client is associated.

txBytesDropped long

Number of Tx bytes dropped during the session

txPacketsDropped long

Number of Tx packets dropped during the session

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Payload

https://172.20.127.108/webacs/api/v3/data/HistoricalClientStats/15

<?xml version="1.0" ?>
<queryResponse type="HistoricalClientStats" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v3/data/HistoricalClientStats/15" rootUrl="https://172.20.127.108/webacs/api/v3/data">
  <entity dtoType="historicalClientStatsDTO" type="HistoricalClientStats" url="https://172.20.127.108/webacs/api/v3/data/HistoricalClientStats/15">
    <historicalClientStatsDTO displayName="String value" id="15" uuid="String value">
      <bytesReceived>2</bytesReceived>
      <bytesSent>2</bytesSent>
      <collectionTime>2</collectionTime>
      <dataRate>3.0</dataRate>
      <dataRetries>2</dataRetries>
      <packetsReceived>2</packetsReceived>
      <packetsSent>2</packetsSent>
      <raPacketsDropped>2</raPacketsDropped>
      <rssi>1</rssi>
      <rtsRetries>2</rtsRetries>
      <rxBytesDropped>2</rxBytesDropped>
      <rxPacketsDropped>2</rxPacketsDropped>
      <snr>1</snr>
      <txBytesDropped>2</txBytesDropped>
      <txPacketsDropped>2</txPacketsDropped>
      <macAddress>String value</macAddress>
    </historicalClientStatsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.20.127.108/webacs/api/v3/data/HistoricalClientStats/15.json

{
  "queryResponse" : {
    "@type" : "HistoricalClientStats",
    "@requestUrl" : "https://172.20.127.108/webacs/api/v3/data/HistoricalClientStats/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://172.20.127.108/webacs/api/v3/data",
    "entity" : [ {
      "@dtoType" : "historicalClientStatsDTO",
      "@type" : "HistoricalClientStats",
      "@url" : "https://172.20.127.108/webacs/api/v3/data/HistoricalClientStats/15",
      "historicalClientStatsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "bytesReceived" : 2,
        "bytesSent" : 2,
        "collectionTime" : 2,
        "dataRate" : 3.0,
        "dataRetries" : 2,
        "macAddress" : "String value",
        "packetsReceived" : 2,
        "packetsSent" : 2,
        "raPacketsDropped" : 2,
        "rssi" : 1,
        "rtsRetries" : 2,
        "rxBytesDropped" : 2,
        "rxPacketsDropped" : 2,
        "snr" : 1,
        "txBytesDropped" : 2,
        "txPacketsDropped" : 2
      }
    } ]
  }
}