baseline

Baseline – Clients Affected by Poor Performance

The graph calculates the baseline for the percentage of clients affected by poor performance for all the clients over a period of time. We can also calculate if the client affected by poor performance is anomalous or not.

JSON Table

Attribute Data Type Description
type String  It is a type of baseline.
baseline Float  It is client affected by poor performance baseline value for the time
stamp.
standardDeviation Float  It is client affected by poor performance standard deviation value
for the time stamp.
anomalous Boolean  This indicates if the clientaffected by poor performance observation
is anomalous or not.
timestamp Int  It is time stamp for current data point in epoch time format.
observation Float  It is the client affected by poor performance observation value for
the time stamp.
absoluteObservation Int  It is absolute value for the client affected by poor performance baseline
observation.
noOfSamplesForObservation Int  It is no of samples considered for client affected by poor performance
observation.
threshold Int
percentageClientsLowDataRate Float  It is percentage of client for low data rate.
noClientsLowDataRate Int  It is no of client for low data rate.
percentageClientsHighRetryRate Float  It is percentage of clients for high retry rate.
 noClientsHighRetryRate  Int  It is no of client for high retry rate.
 percentageClientsLowRssi  Float  It is percentage of clients for low rssi.
 noClientsLowRssi  Int  It is no of clients for low rssi.
 percentageClientsSticky  Int
 noClientsSticky  Int

Copy Sample JSON
Sample JSON 
[
    {
        "type": "clientsperformance",
        "baseline": 24.82306720385911,
        "standardDeviation": 8.252812112574356,
        "anomalous": false,
        "timestamp": 1520299800000,
        "observation": 40.74074074074074,
        "absoluteObservation": 11,
        "noOfSamplesForObservation": 27,
        "threshold": 0,
        "percentageClientsLowDataRate": 37.03703703703704,
        "noClientsLowDataRate": 10,
        "percentageClientsHighRetryRate": 0,
        "noClientsHighRetryRate": 0,
        "percentageClientsLowRssi": 7.4074074074074066,
        "noClientsLowRssi": 2,
        "percentageClientsSticky": 0,
        "noClientsSticky": 0
    },
    {
        "type": "clientsperformance",
        "baseline": 24.885181359406726,
        "standardDeviation": 8.234669231451825,
        "anomalous": false,
        "timestamp": 1520300700000,
        "observation": 31.03448275862069,
        "absoluteObservation": 9,
        "noOfSamplesForObservation": 29,
        "threshold": 0,
        "percentageClientsLowDataRate": 31.03448275862069,
        "noClientsLowDataRate": 9,
        "percentageClientsHighRetryRate": 0,
        "noClientsHighRetryRate": 0,
        "percentageClientsLowRssi": 6.896551724137931,
        "noClientsLowRssi": 2,
        "percentageClientsSticky": 0,
        "noClientsSticky": 0
    },
    {
        "type": "clientsperformance",
        "baseline": 24.96966287914599,
        "standardDeviation": 8.236398191471398,
        "anomalous": false,
        "timestamp": 1520301600000,
        "observation": 33.33333333333333,
        "absoluteObservation": 9,
        "noOfSamplesForObservation": 27,
        "threshold": 0,
        "percentageClientsLowDataRate": 29.629629629629626,
        "noClientsLowDataRate": 8,
        "percentageClientsHighRetryRate": 3.7037037037037033,
        "noClientsHighRetryRate": 1,
        "percentageClientsLowRssi": 3.7037037037037033,
        "noClientsLowRssi": 1,
        "percentageClientsSticky": 0,
        "noClientsSticky": 0
    },

    {
        "type": "clientsperformance",
        "baseline": 25.271030362978827,
        "standardDeviation": 7.956794381707328,
        "anomalous": false,
        "timestamp": 1520313300000,
        "observation": 24.786324786324787,
        "absoluteObservation": 29,
        "noOfSamplesForObservation": 117,
        "threshold": 0,
        "percentageClientsLowDataRate": 17.094017094017094,
        "noClientsLowDataRate": 20,
        "percentageClientsHighRetryRate": 5.128205128205128,
        "noClientsHighRetryRate": 6,
        "percentageClientsLowRssi": 2.564102564102564,
        "noClientsLowRssi": 3,
        "percentageClientsSticky": 0,
        "noClientsSticky": 0
    }
]
API Calls
Get

/V5/baselines/clientsperformance

GET Baseline – Clients Affected by Poor Performance

Description This API is used to fetch the baseline data for clients affected by poor performance
over a period of time.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/V5/baselines/clientsperformance?frequencyband=<Value>
&fromtime=<Value>&locationid=<Value>&nodeid=<Value>&ssid=<Value>
&totime=<Value>&macaddress=<Value>

Here,

  • frequencyband

    It is used to specify frequency band. Possible values are 2.4GHz, 5GHz and ANY.
    Default value is ANY.

  • fromtime

    Is used to specify start time for baseline data of clients affected by poor performance
    over a period of time. It takes an integer value in epoch format. Sample value, 1520276744482.

  • totime

    Is used to specify end time for baseline data of clients affected by poor performance
    over a period of time. an integer value in epoch format. Sample value, 1520320844482.

  • locationid

    Is used to specify location on which baseline data for clients affected by poor performance
    has to be fetched. It takes an integer value. To retrieve the value for location id refer
    Location call.

  • nodeid

    Is used to specify child node id if the location belong to child server. It takes an integer value.

  • ssid

    It is used to specify SSID name to which client is connected and affected by poor performance.
    If not specified, all the SSIDs are considered. It takes a string value. Sample value, MOJO-BYOD.
    To retrieve the value for SSIDs refer Get SSIDs Configured on a Managed Device call.

  • macaddress

    It is used to specify mac-address of the clients. It takes a string value.
    Sample value, 00:11:74:F2:03:9F.
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/baselines/
clientsperformance?frequencyband=ANY&fromtime=1520276744482&
locationid=23&macaddress=00:11:74:F2:03:9F&nodeid=0&
ssid=Spectrum&totime=1520320844482
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 performance baseline data points. 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.