get_top_clients_using_an_application

Top Clients Using an Application

This generates the list of the top 10 clients that are using the application currently. This can be viewed from the Application Visibility tab.

JSON Table

Attribute Data Type Description
applicationId int A system-defined ID for the application.
applicationName String Name of the application.
categoryName String Category under which the application falls.
clientInfoList application/json List of clients that used the application.
clientInfoList/boxId int Client device identifier.
clientInfoList/locationId application/json The ID of the client’s location, which is a JSON object. For details about the JSON, click Location ID.
clientInfoList/macAddress String MAC adress of the client.
clientInfoList/clientName String Name of the client.
clientInfoList/ipAddress String IP address of the client.
clientInfoList/clientUserName String Username used to establish the WiFi session for accessing the application from the client.
clientInfoList/recentlyAssociatedSSID String Name of the recently associated SSID.
clientInfoList/recievingBytes long Total bytes received by the client when accessing the appplication.
clientInfoList/transmittingBytes long Total bytes transmitted by the client when accessing the appplication.
clientInfoList/totalRecievingBytes long Total bytes received by the client.
clientInfoList/totalTransmittingBytes long Total bytes transmitted by the client.

Copy Sample JSON
Sample JSON 
[
   {
       "applicationId": 65,
       "applicationName": "DNS",
       "categoryName": "Networking",
       "clientInfoList":
       [
           {
               "boxId": 2103344512,
               "locationId":
               {
                   "type": "locallocationid",
                   "id": 7
               },
               "macAddress": "44:00:10:6A:45:9F",
               "clientName": "Apple_6A:45:9F",
               "ipAddress": "172.16.100.85",
               "clientUserName": "--",
               "recentlyAssociatedSSID": "sp_analysis",
               "recievingBytes": 1532,
               "transmittingBytes": 694,
               "totalRecievingBytes": 53328,
               "totalTransmittingBytes": 29936
           },

           . . .
           . . .
           . . .
       ]
    }   
]
API Calls
Get

/V5/applications/clients

Get Top Clients Using an Application

Description This API fetches the list of top 25 clients based on application usage in the
specified duration.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/applications/clients?ssid=<Value>&applicationid=<Value>&duration=<Value>

Here,

  • duration

    Retrieve top 25 clients based on application usage within the specified time interval
    in minutes. It takes an integer value. The application usage information is chunked for
    15 minute intervals for the past 1 hour and in hourly intervals for duration more than
    1 hour. The 15 minute intervals are defined for every 15 minutes within an hour.
    For example, 00:00-00:015, 00:15-00:30, and so on.

  • ssid

    Fetch top clients connected to the given SSID. It takes a string value. This is a mandatory parameter.
    If you want to fetch the client list for multiple SSIDs, then each SSID must be provided separately
    in the URL. To retrieve the value for SSIDs refer Get SSIDs Configured on a Managed Device call.

  • applicationid

    Fetch top clients based on the usage of the the specified application. It takes an integer value.
    If not specified, the response will be empty. If you want to fetch the top client list for
    multiple applications, then each application id must be provided separately in the URL.
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/applications/
clients?duration=15&ssid=test&applicationid=1&applicationid=2
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 details of the clients that accessed the application.
The response is in the application/json format.

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.