client-events

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:

  • UNKNOWN
  • A
  • B
  • BG
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:

  • Success
  • Failure
  • Intermediate
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:

  • 1=Association
  • 2=Authentication
  • 3=Network
  • 4=Client Steering
  • 5=Quarantine

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
Get

/V5/devices/clientevents/{macaddress}/{offset}/{limit}

Put

<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}

Get Client Events

Description This API provides connectivity event records for a client. These events contain
connection Success events,connection Failure events and all the Intermediate events.
Users with the roles can call this API:superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/devices/clientevents/{macaddress}/{offset}/{limit}

Here,

  • macaddress

    Is used to specify client for which connection events are to be fetched.
    It takes string value. It is mandatory field.

  • offset

    Is used to specify offset from which the next page of clients are to be fetched.
    It takes an integer value.

  • limit

    Is used to specify page size of clients to be fetched. It takes an integer value.

  • locationid

    Is used to specify location identifier of the client. It takes an integer value.
    To retrieve the value for location id refer Location call.

  • nodeid

    Is used to specify node identifier in case of multi server deployment.
    It takes an integer value. Default value is 0.

  • totalcountrequired

    Is used to specify total count of client events which is required.
    It takes a boolean value. Default value is false.

  • fromtime

    Is the time in milliseconds indicating the starting time from which
    client events are to be fetched. It takes an integer value.

  • totime

    Is the time in milliseconds indicating the time until which client
    events are to be fetched. It takes an Integer value.

  • clienteventtype

    Is used to specify which type of events are to be returned.
    It takes a string value. Possible values are Failure, Success, Intermediate.

  • failureoreventtypecode

    Is used to fetch exact event by failure code or event type code.
    It takes an integer value.

  • eventcategory

    Is used to specify events of which category are to be returned.
    It takes an integer value.

  • protocol

    Is used to specify client events of which protocol are to be returned.
    It takes a string value. Possible values are A and BG.

  • ssid

    Is used to specify list of SSIDs for client events which are to be returned.
    It takes string value. To fetch the list of ssids you can use Get SSIDs Configured on a Managed Device call.
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices
/clientevents/68:05:71:A4:EF:0E/2/2

 

GET https://training.mojonetworks.com/new/webservice/V5/devices
/clientevents/CC:C3:EA:14:99:E4/0/100?totalcountrequired=3&ssid=varsha
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the connectivity event records for a client. The response is in the
application/json format. It additionally contains the following three attributes:

  • Previous Link

    Link for previous page of results. It takes string value. Sample value,

    https://training.mojonetworks.com/new/webservice/V5/devices/clientevents/
    68:05:71:A4:EF:0E/2/2
  • Next Link

    Link for next page of results. It takes a string value. Sample value,

    https://training.mojonetworks.com/new/webservice/V5/devices/clientevents/
    CC:C3:EA:14:99:E4/0/100
  • Total Count

    Count for total available events. It takes an integer value. Sample value, 3.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Post APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Delete APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.