get_application_voip_statistics

Get Application VOIP Statistics

This generates the statistics for the traffic that has been created and generated by the connected VOIP applications including skype, skype for business, voip call details and so.

JSON Table

Attribute Data Type Description
applicationId int  A system-defined ID for the application.
applicationCategoryId int  It is system defined ID for application.
noOfGoodSessions int  It specifies number of good application usage sessions.
noOfBadSessions int  It specifies number of bad application usage sessions.
noOfClientsWithGoodApplicationUsageExperience int  It specifies number of clients with good application usage experience.
noOfClientsWithBadApplicationUsageExperience int  It specifies number of clients with bad application usage experience.
percentageOfClientsWithBadApplicationUsageExperience int  It specifies from all the clients using application, what percentage
of clients are having bad application usage experience.
noOfSecondsWithGoodUsageExperience int  It specifies total good application usage experience in seconds.
noOfSecondsWithBadUsageExperience int  It specifies total bad application usage experience in seconds.
percentageOfSecondsWithBadUsageExperience int  It specifies from total application usage what percentage of time in
seconds is bad.
totalDataReceived int  Total data received during all sessions of the applications.
totalDataTransmitted int  Total data transmitted during all sessions of the applications.

Copy Sample JSON
Sample JSON
[
    {
        "applicationId": 480,
        "applicationCategoryId": 1,
        "noOfGoodSessions": 6,
        "noOfBadSessions": 24,
        "noOfClientsWithGoodApplicationUsageExperience": 6,
        "noOfClientsWithBadApplicationUsageExperience": 21,
        "percentageOfClientsWithBadApplicationUsageExperience": 76,
        "noOfSecondsWithGoodUsageExperience": 5070,
        "noOfSecondsWithBadUsageExperience": 6330,
        "percentageOfSecondsWithBadUsageExperience": 71,
        "totalDataReceived": 201424084,
        "totalDataTransmitted": 132923932
    },
    {
        "applicationId": 564,
        "applicationCategoryId": 1,
        "noOfGoodSessions": 7,
        "noOfBadSessions": 18,
        "noOfClientsWithGoodApplicationUsageExperience": 7,
        "noOfClientsWithBadApplicationUsageExperience": 18,
        "percentageOfClientsWithBadApplicationUsageExperience": 71,
        "noOfSecondsWithGoodUsageExperience": 1380,
        "noOfSecondsWithBadUsageExperience": 900,
        "percentageOfSecondsWithBadUsageExperience": 70,
        "totalDataReceived": 154493108,
        "totalDataTransmitted": 33146090
    },
    {
        "applicationId": 1181,
        "applicationCategoryId": 1,
        "noOfGoodSessions": 4,
        "noOfBadSessions": 61,
        "noOfClientsWithGoodApplicationUsageExperience": 4,
        "noOfClientsWithBadApplicationUsageExperience": 59,
        "percentageOfClientsWithBadApplicationUsageExperience": 94,
        "noOfSecondsWithGoodUsageExperience": 840,
        "noOfSecondsWithBadUsageExperience": 2160,
        "percentageOfSecondsWithBadUsageExperience": 93,
        "totalDataReceived": 105946315,
        "totalDataTransmitted": 73985240
    },
    {
        "applicationId": 448,
        "applicationCategoryId": 1,
        "noOfGoodSessions": 0,
        "noOfBadSessions": 11,
        "noOfClientsWithGoodApplicationUsageExperience": 0,
        "noOfClientsWithBadApplicationUsageExperience": 11,
        "percentageOfClientsWithBadApplicationUsageExperience": 100,
        "noOfSecondsWithGoodUsageExperience": 0,
        "noOfSecondsWithBadUsageExperience": 660,
        "percentageOfSecondsWithBadUsageExperience": 100,
        "totalDataReceived": 3438269,
        "totalDataTransmitted": 2233011
    }
]
API Calls

/V5/applications/voip

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

Get Application VOIP Statistics

Description This API is used to fetch good and bad application sessions, traffic, experience
and client data for each supported application.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/applications/voip?ssid=<Value>&protocol=<Value>
&sortby=<Value>&ascending=<Value>

Here,

  • ssid

    It specifies the SSIDs for which we have to fetch the trend. It takes a string value.
    If you want to fetch the trend 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. Sample value, MOJO-BYOD.

  • ascending

    Is used to specify Sort direction. It takes Boolean value. Default value is true.

  • protocol

    Associated 802.11 protocol. The applicable values are:

    • A
    • B
    • BG
  • sortby

    Is used to sort application data.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/applications/voip
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 application statistics. 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.