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

# GET ClientStats

Represents the latest polled client statistics data. The data represented here are the counters retrieved from controllers. The counters only get reset in new sessions.

Since Product Version: 1.2

- Jump To

- v1
- v2
- v3
- v4

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

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/data/ClientStats

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://10.64.88.203/webacs/api/v1/data/ClientStats/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/ClientStats/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="clientStatsDTO" type="ClientStats" url="https://10.64.88.203/webacs/api/v1/data/ClientStats/15">
        <clientStatsDTO 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>
        </clientStatsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/ClientStats/15.json

    {
      "queryResponse" : {
        "@type" : "ClientStats",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/ClientStats/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "clientStatsDTO",
          "@type" : "ClientStats",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/ClientStats/15",
          "clientStatsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "bytesReceived" : 2,
            "bytesSent" : 2,
            "collectionTime" : 2,
            "dataRate" : 3,
            "dataRetries" : 2,
            "packetsReceived" : 2,
            "packetsSent" : 2,
            "raPacketsDropped" : 2,
            "rssi" : 1,
            "rtsRetries" : 2,
            "rxBytesDropped" : 2,
            "rxPacketsDropped" : 2,
            "snr" : 1,
            "txBytesDropped" : 2,
            "txPacketsDropped" : 2,
            "macAddress" : "String value"
          }
        }
      }
    }

### 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/v2/data/ClientStats

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://10.64.88.203/webacs/api/v2/data/ClientStats/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/ClientStats/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="clientStatsDTO" type="ClientStats" url="https://10.64.88.203/webacs/api/v2/data/ClientStats/15">
        <clientStatsDTO 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>
        </clientStatsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/ClientStats/15.json

    {
      "queryResponse" : {
        "@type" : "ClientStats",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/ClientStats/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "clientStatsDTO",
          "@type" : "ClientStats",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/ClientStats/15",
          "clientStatsDTO" : {
            "@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
          }
        } ]
      }
    }

### 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/ClientStats

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://10.64.88.203/webacs/api/v3/data/ClientStats/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/ClientStats/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="clientStatsDTO" type="ClientStats" url="https://10.64.88.203/webacs/api/v3/data/ClientStats/15">
        <clientStatsDTO 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>
        </clientStatsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/ClientStats/15.json

    {
      "queryResponse" : {
        "@type" : "ClientStats",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/ClientStats/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "clientStatsDTO",
          "@type" : "ClientStats",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/ClientStats/15",
          "clientStatsDTO" : {
            "@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
          }
        } ]
      }
    }

### 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/v4/data/ClientStats

Updated

Since version 4 type of macAddress attribute is MacAddress.

## 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 MacAddress | 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://10.64.88.203/webacs/api/v4/data/ClientStats/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/ClientStats/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="clientStatsDTO" type="ClientStats" url="https://10.64.88.203/webacs/api/v4/data/ClientStats/15">
        <clientStatsDTO 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>
            <octets>000a959d6816</octets>
          </macAddress>
        </clientStatsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/ClientStats/15.json

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