Get Application Session Logs

Application session logs provides the details for the applications that are being used by the client. You can simply select the client from view application session logs.

JSON Table

Attribute	Data Type	Description
applicationId	int	A system-defined ID for the application.
applicationCategory	int	It specifies category of application.
clientMac	String	It specifies mac address of the clients involved in the application session.
sessionId	int	It is system defined Id for application session.
apsAssociatedWithClient	int	It specifies list of macaddresses of Aps associated with the client .
apsAssociatedWithClient/macaddress	String	It specifies macaddress of an AP associated with that client.
locationId	int	It specifies client location id.
sessionStartTime	int	It specifies session start time in epoch format.
sessionEndTime	int	It specifies session end time in epoch format.
averageBitRateReceived	int	Number of bits received per second. (Note – If the data belongs to multiple AP’s, data(bitrate, jitter, etc) would be averaged)
averageBitRateTransmitted	int	Number of bits sent per second
averagePacketRateReceived	int	Number of packets received per second
averagePacketRateTransmitted	int	Number of packets sent per second
averageJitterReceived	int	Standard deviation of bitrate Rx
averageJitterTransmitted	int	Standard deviation of bitrate Tx
averagePacketRateJitterReceived	int	Standard deviation of Packet Rate Rx
averagePacketRateJitterTransmitted	int	Standard deviation of Packet Rate Tx
averageRSSI	int	RSSI
averageDataRateReceived	int	Data Rate Rx
averageDataRateTransmitted	int	Data Rate Tx
totalDataPacketsReceived	int	Number of total data packets Rx
totalDataPacketsTransmitted	int	Number of total data packets Tx
totalRetryPacketsReceived	int	Number of total retry packets Rx
totalRetryPacketsTransmitted	int	Number of total retry packets Tx
averageUserSatisfactionIndexReceived	int	USI (User Satisfaction index). Application quality will be measured in term of USI score(USI Rx and USI Tx). USI score will be calculated at AP level for each chunk
averageUserSatisfactionIndexTransmitted	int	It specifies total good application usage experience of the client in seconds.
noOfSecondsClientExperienceGood	int	It specifies total good application usage experience of the client in seconds.
noOfSecondsClientExperienceBad	int	It specifies total bad application usage experience of the client in seconds.
noOfBadChunksReceivedThroughWiredMedium	int	Number of bad chunks having wired issue
noOfBadChunksReceivedThroughWirelessMedium	int	Number of bad chunks having wireless issue
totalDataReceived	int	It specifies the total data received in the application session.
totalDataTransmitted	int	It specifies the total data transmitted in the application session.
sessionQuality	int	Overall session quality
noOfRoams	int	Number of roams
rca	int	RCA (Root Cause Analysis) 0 – Success 1 – Wired 2 – Wireless 3 – Both (Wired & Wireless)

Sample JSON

[
    {
        "applicationId": 1181,
        "clientMac": "1c:4d:70:41:d0:70",
        "applicationCategory": 1,
        "sessionId": 4868,
        "apsAssociatedWithClient": {
            "macaddress": [
                "00:11:74:F2:14:60"
            ]
        },
        "locationId": {
            "type": "locallocationid",
            "id": 22
        },
        "sessionStartTime": 1519634826000,
        "sessionEndTime": 1519634843000,
        "averageBitRateReceived": 168552,
        "averageBitRateTransmitted": 24584,
        "averagePacketRateReceived": 24,
        "averagePacketRateTransmitted": 19,
        "averageJitterReceived": 110036,
        "averageJitterTransmitted": 15374,
        "averagePacketRateJitterReceived": 12,
        "averagePacketRateJitterTransmitted": 11,
        "averageRSSI": -71,
        "averageDataRateReceived": 0,
        "averageDataRateTransmitted": 197,
        "totalDataPacketsReceived": 2414,
        "totalDataPacketsTransmitted": 2480,
        "totalRetryPacketsReceived": 0,
        "totalRetryPacketsTransmitted": 337,
        "averageUserSatisfactionIndexReceived": 0,
        "averageUserSatisfactionIndexTransmitted": 0,
        "noOfSecondsClientExperienceGood": 0,
        "noOfSecondsClientExperienceBad": 30,
        "noOfBadChunksReceivedThroughWiredMedium": 1,
        "noOfBadChunksReceivedThroughWirelessMedium": 1,
        "totalDataReceived": 316048,
        "totalDataTransmitted": 46105,
        "sessionQuality": 0,
        "noOfRoams": 0,
        "rca": 3
    },
    {
        "applicationId": 564,
        "clientMac": "1c:4d:70:41:d0:70",
        "applicationCategory": 1,
        "sessionId": 4864,
        "apsAssociatedWithClient": {
            "macaddress": [
                "00:11:74:F2:20:80"
            ]
        },
        "locationId": {
            "type": "locallocationid",
            "id": 3
        },
        "sessionStartTime": 1519623037000,
        "sessionEndTime": 1519623057000,
        "averageBitRateReceived": 96384,
        "averageBitRateTransmitted": 24264,
        "averagePacketRateReceived": 15,
        "averagePacketRateTransmitted": 15,
        "averageJitterReceived": 64715,
        "averageJitterTransmitted": 20264,
        "averagePacketRateJitterReceived": 10,
        "averagePacketRateJitterTransmitted": 10,
        "averageRSSI": -28,
        "averageDataRateReceived": 0,
        "averageDataRateTransmitted": 13,
        "totalDataPacketsReceived": 18,
        "totalDataPacketsTransmitted": 22,
        "totalRetryPacketsReceived": 0,
        "totalRetryPacketsTransmitted": 2,
        "averageUserSatisfactionIndexReceived": 0,
        "averageUserSatisfactionIndexTransmitted": 10,
        "noOfSecondsClientExperienceGood": 0,
        "noOfSecondsClientExperienceBad": 30,
        "noOfBadChunksReceivedThroughWiredMedium": 0,
        "noOfBadChunksReceivedThroughWirelessMedium": 1,
        "totalDataReceived": 180730,
        "totalDataTransmitted": 45496,
        "sessionQuality": 0,
        "noOfRoams": 0,
        "rca": 2
    }
]

API Calls

Get

/V5/applications/clients/sessions/{macaddress}

Get Application Session Logs

Description	This API is used to fetch session logs of client using application. Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax	GET <Base_URL>/applications/clients/sessions/{macaddress}? applicationid=<Value> Here, applicationid Id of application for which data has to be fetched. It takes an integer value. macaddress MAC address of the client. It takes a string value. Sample value, 1C:4D:70:41:D0:70
Sample code	GET https://training.mojonetworks.com/new/webservice/V5/applications /clients/sessions/1C:4D:70:41:D0:70
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 list of client session logs. The response is in the application/json format.

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.

Understand Arista Cloud Architecture

Know what Arista APIs can do

Know how Arista APIs work?

API Reference

Get Application Session Logs