Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_ClientStats

GET ClientStats

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

HTTP Methods

GET

Represents client statistics data collected during last polling cycle in NCS. The data represented here are the counters retrieved from controllers. The counters only get reset in new sessions.

Resource URL

/webacs/api/v1/data/ClientStats

Since : 1.2

Response Parameters

Type Attribute Name Description

long

bytesReceived

number of bytes received during the session

long

bytesSent

number of bytes sent during the session

long

collectionTime

binary timestamp of the collection time

float

dataRate

Datarate reading

long

dataRetries

Number data retries during the session

String

macAddress

Client MAC address

long

packetsReceived

number packets received durin the session

long

packetsSent

Number of packets sent during the session

long

raPacketsDropped

number of IPv6 RA packets dropped during the session

int

rssi

RSSI reading

long

rtsRetries

number of RTS retries during the session

long

rxBytesDropped

Number of Rx bytes dropped during the session

long

rxPacketsDropped

Number of Rx packets dropped during the session

int

snr

SNR reading

long

txBytesDropped

Number of Tx bytes dropped during the session

long

txPacketsDropped

Number of Tx packets dropped during the session

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://192.168.116.207/webacs/api/v1/data/ClientStats/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/ClientStats/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="clientStatsDTO_$$_javassist_5991">
        <clientStatsDTO id="15" displayName="String value">
            <bytesReceived>2</bytesReceived>
            <bytesSent>2</bytesSent>
            <collectionTime>2</collectionTime>
            <dataRate>3.0</dataRate>
            <dataRetries>2</dataRetries>
            <macAddress>String value</macAddress>
            <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>
        </clientStatsDTO>
    </entity>
</queryResponse>

Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/ClientStats/42.json

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/ClientStats\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "clientStatsDTO_$$_javassist_5991",
      "clientStatsDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "bytesReceived" : 2,
        "bytesSent" : 2,
        "collectionTime" : 2,
        "dataRate" : 3,
        "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
      }
    }
  }
}