clients_top_applications

Client’s Top Applications

Top Applications used by the client are displayed graphically that displays the top 5 applications used by the client and the traffic generated by them. It always represents the traffic in decreasing order by the particular application. The application for which highest traffic is consumed is displayed first and so on. This is for particular time intervals- 2hours, 4 hours, 8 hours, 12 hours, or 1 week.

JSON Table

Attribute Data Type Description
clientMacAddress String MAC address of a client .
applicationDetails application/json
applicationDetails/applicationId long System-generated ID of the application.
applicationDetails/applicationName String Name of the application.
applicationDetails/categoryName String Category of the application.
applicationDetails/recievingBytes long No of bytes recieved.
applicationDetails/transmittingBytes long No of bytes transmitted.

Copy Sample JSON
Sample JSON 
[{
 	"clientMacAddress": "90:48:9A:8A:2D:A1",
 	"applicationDetails": [{
 			"applicationId": 796,
 			"applicationName": "OCSP",
 			"categoryName": "Networking",
 			"recievingBytes": 4898,
 			"transmittingBytes": 240
 		}

 	]
 }]
API Calls
Get

/V5/devices/clients/applications

Get Top Applications for a Client

Description This API is used to fetch applications used by a specified client and sort them based on data usage (highest to lowest).
Users with the following roles can call this API: super user, administrator, operator, and viewer.
Syntax
GET <Base_URL>/devices/clients/applications?macaddress=<value>&duration=<value>

Here,

  • macaddress

    It is used to specify MAC address of a client. it takes String value.
    It is a mandatory field. To fetch the appropriate macaddress refer Clients.

  • duration

    It is used to specify the time in minutes. It takes an Integer value.
    It is a mandatory field.
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/clients/applications?macaddress=90:48:9A:8A:2D:A1&duration=240
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 list of top Applications for clients in the application/json format.