Get Client Events
Client Events mention the various event records for a client. Client Events are categorized into 5 major categories and divided into various intermediate events. Those categories are BSSID, AP Name, SSID, Channel, Timestamp, Event, and Packet Capture.
JSON Table
Attribute | Data Type | Description |
---|---|---|
macAddress | String | MAC address of the device. |
protocol | String | The 802.11 protocol version associated with the device. The applicable values are:
|
locationId | application/json | Location identifier for the client. The value is of the type Location ID JSON. |
eventType | String | Type of event. The applicable values are:
|
bssid | String | BSSID of the associared AP. |
channel | int | Channel no used for connection. |
ssid | String | SSID Name. |
timestamp | int | Connection timestamp. |
associatedAPName | String | Name of the associated AP. |
categoryCode | int | Category ID of intermediate event. The applicable values are:
Applicable only when event type is Intermediate. |
typeCode | int | Type ID of intermediate event. Applicable only when event type is Intermediate. To retrieve the value for Type Id of intermediate event refer Intermediate event type Id. |
subTypeCode | int | Type ID of intermediate sub-event. Applicable only when event type is Intermediate. To retrieve the value for type Id of the intermediate event refer Intermediate event type Id. |
category | String | Category of intermediate event. Applicable only when event type is Intermediate. |
eventDescription | String | A short description of the intermediate event. Applicable only when event type is Intermediate. |
subEventDescription | String | A short description of the intermediate sub-event. Applicable only when event type is Intermediate. |
vlan | int | VLAN of the client. Applicable only when event type is Intermediate. |
ip | String | Ip address of the client. Applicable only when event type is Intermediate. |
bwUpload | int | Upload bandwidth. Applicable only when event type is Intermediate. |
bwDownload | int | Download bandwidth. Applicable only when event type is Intermediate. |
rssi | int | Signal strength. Applicable only when event type is Intermediate. |
bwPriority | int | Bandwidth priority. Applicable only when event type is Intermediate. |
radiusPrimaryIP | String | Primary radius IP. Applicable only when event type is Intermediate. |
radiusSecondaryIP | String | Secondary radius IP. Applicable only when event type is Intermediate. |
assocCount | int | Number of association. Applicable only when event type is Intermediate. |
detailedRole | String | Role assigned to a client.Applicable only when event type is Intermediate. |
detailedGoogleOU | String | Google OU,if Google integration is enabled. Applicable only when event type is Intermediate. |
thresholdRssi | int | RSSI threshold for steering operations. Applicable only when event type is Intermediate. |
bwSource | String | Bandwidth source. Applicable only when event type is Intermediate. |
clCount2Ghz | int | Number of clients in 2.4GHz band.Applicable only when event type is Intermediate. |
clCount5Ghz | int | Number of clients in 5GHz band.Applicable only when event type is Intermediate. |
bstNbrRssi | int | Best neighbour RSSI. Applicable only when event type is Intermediate. |
bstNbrMac | String | Best neighbour MAC address. Applicable only when event type is Intermediate. |
bstNbrClCnt | int | Best neighbour client count. Applicable only when event type is Intermediate. |
disTime | int | Disassociation time. Applicable only when event type is Intermediate. |
nbrCnt | int | Neighbour count. Applicable only when event type is Intermediate. |
associationTimestamp | int | Client association timestamp. Applicable only when event type is Success or Failure. |
authenticationTimestamp | int | Client authentication timestamp. Applicable only when event type is Success or Failure. |
networkTimestamp | int | Client connection timestamp. Applicable only when event type is Success or Failure. |
failureCode | int | Category code of failures. Applicable only when event type is Failure. |
failure | String | Category of failures. For the types of failures and there ID refer Failure Code. Applicable only when event type is Failure. |
subFailureCode | int | Specific failure code in a category. Applicable only when event type is Failure. |
subFailure | String | Specific failure in a category. Applicable only when event type is Failure. |
fileId | String | ID of a file containing client connection logs. Applicable only when event type is Failure. |
autoTestSessionId | int | Session id of client connectivity test session. Applicable only when event type is Success or Failure. |
autoTestStatusCode | int | Current status code of auto client connectivity test. Applicable only when event type is Success or Failure. |
dnsLatency | int | Value in seconds for dnsLatency. Applicable only when event type is Success. |
aaaLatency | int | Value in seconds for aaa Latency. Applicable only when event type is Success. |
dhcpLatency | int | Value in seconds for dhcp Latency. Applicable only when event type is Success. |
autoTestStatus | String | Current status of auto client connectivity test. Applicable only when event type is Success or Failure. |
Copy Sample JSON
Sample JSON
{ "previousLink": "https://192.168.55.141/new/webservice/V5/devices/clientevents/68:05:71:A4:EF:0E/0/3", "nextLink": "https://192.168.55.141/new/webservice/V5/devices/clientevents/68:05:71:A4:EF:0E/3/3", "totalCount": 3, "clientEvents":[{ "macAddress": "68:05:71:a4:ef:0e", "protocol": "BG", "locationId":{ "type": "locallocationid", "id": -1 }, "eventType": "Intermediate", "bssid": "00:11:74:8c:94:c0", "channel": 11, "timestamp": 1505109958843842, "associatedAPName": "Mojo_8C:94:DF", "ssid": "varsha", "categoryCode": 0, "typeCode": 23, "subTypeCode": 0, "category": "####", "eventDescription": "####", "subEventDescription": "####", "vlan": null, "ip": "10.9.1.17", "bwUpload": null, "bwDownload": null, "rssi": null, "bwPriority": null, "radiusPrimaryIP": null, "radiusSecondaryIP": null, "assocCount": null, "detailedRole": null, "detailedGoogleOU": null, "thresholdRssi": null, "bwSource": null, "clCount2Ghz": null, "clCount5Ghz": null, "bstNbrRssi": null, "bstNbrMac": null, "bstNbrClCnt": null, "disTime": null, "nbrCnt": null }, { "macAddress": "68:05:71:a4:ef:0e", "protocol": "BG", "locationId": { "type": "locallocationid", "id": -1 }, "eventType": "Success", "bssid": "00:11:74:8c:94:c0", "channel": 11, "timestamp": 1505109958917419, "associatedAPName": "Mojo_8C:94:DF", "ssid": "varsha", "associationTimestamp": 1505109957000, "authenticationTimestamp": 1505109957000, "networkTimestamp": 1505109958000, "autoTestSessionId": null, "autoTestStatusCode": 0, "autoTestStatus": null, "dhcpLatency": 4, "aaaLatency": 0, "dnsLatency": 74 }, { "macAddress": "68:05:71:A4:EF:0E", "protocol": "BG", "locationId": { "type": "locallocationid", "id": -1 }, "eventType": "Failure", "bssid": "00:11:74:8c:94:c0", "channel": 11, "timestamp": 1505109280172449, "associatedAPName": "Mojo_8C:94:DF", "ssid": "varsha", "associationTimestamp": 1505109280000, "authenticationTimestamp": 1505109280000, "networkTimestamp": 1505109280000, "autoTestSessionId": null, "autoTestStatusCode": 0, "autoTestStatus": null, "failureCode": 7, "failure": "Incorrect PSK", "subFailureCode": 14, "subFailure": "Wrong passphrase.", "fileId": "" } ]}
API Calls
/V5/devices/clientevents/{macaddress}/{offset}/{limit}
<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}