baseline

Baseline – Clients Affected by Failures

Mojo Aware calculates a baseline for the percentageĀ of clients that failed due to connectivity issues. The connectivity issues considerĀ the issues like- Authentication Failure, Association failure, and Network failure.

JSON Table

Attribute Data Type Description
type String It is a type of baseline.
baseline Float It is client affected by failure baseline value for the time stamp.
standardDeviation Float It is client affected by failure standard deviation value for the time
stamp.
anomalous Boolean This indicates if the client connectivity issue 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 connectivity failure observation value for the time
stamp.
absoluteObservation Int It is absolute value for the client connectivity failure observation.
noOfSamplesForObservation Int It is no of samples considered for client connectivity failure observation.
threshold Float
percentageClientsAuthFailure Float
noClientsAuthFailure Int
percentageClientsNetworkFailure Float It is percentage of client due to network failure.
noClientsNetworkFailure Int It is number of clients due to network failure.
percentageClientsAssociationFailure Float
noClientsAssociationFailure Int

Copy Sample JSON
Sample JSON
[{
		"type": "clientsconnectivity",
		"baseline": 15.517363621917989,
		"standardDeviation": 12.404832701491616,
		"anomalous": false,
		"timestamp": 1520276400000,
		"observation": 14.285714285714285,
		"absoluteObservation": 1,
		"noOfSamplesForObservation": 7,
		"threshold": 0.0,
		"percentageClientsAuthFailure": 14.285714285714285,
		"noClientsAuthFailure": 1,
		"percentageClientsNetworkFailure": 0.0,
		"noClientsNetworkFailure": 0,
		"percentageClientsAssociationFailure": 0.0,
		"noClientsAssociationFailure": 0
	},
	{
		"type": "clientsconnectivity",
		"baseline": 15.612189985698809,
		"standardDeviation": 12.378662589149005,
		"anomalous": false,
		"timestamp": 1520277300000,
		"observation": 25.0,
		"absoluteObservation": 2,
		"noOfSamplesForObservation": 8,
		"threshold": 0.0,
		"percentageClientsAuthFailure": 25.0,
		"noClientsAuthFailure": 2,
		"percentageClientsNetworkFailure": 0.0,
		"noClientsNetworkFailure": 0,
		"percentageClientsAssociationFailure": 0.0,
		"noClientsAssociationFailure": 0
	},
	{
		"type": "clientsconnectivity",
		"baseline": 15.789401419175155,
		"standardDeviation": 12.44218469338711,
		"anomalous": false,
		"timestamp": 1520278200000,
		"observation": 33.33333333333333,
		"absoluteObservation": 3,
		"noOfSamplesForObservation": 9,
		"threshold": 0.0,
		"percentageClientsAuthFailure": 33.33333333333333,
		"noClientsAuthFailure": 3,
		"percentageClientsNetworkFailure": 0.0,
		"noClientsNetworkFailure": 0,
		"percentageClientsAssociationFailure": 0.0,
		"noClientsAssociationFailure": 0
	},
	{
		"type": "clientsconnectivity",
		"baseline": 15.774364547840545,
		"standardDeviation": 12.380721505121047,
		"anomalous": false,
		"timestamp": 1520279100000,
		"observation": 14.285714285714285,
		"absoluteObservation": 1,
		"noOfSamplesForObservation": 7,
		"threshold": 0.0,
		"percentageClientsAuthFailure": 14.285714285714285,
		"noClientsAuthFailure": 1,
		"percentageClientsNetworkFailure": 0.0,
		"noClientsNetworkFailure": 0,
		"percentageClientsAssociationFailure": 0.0,
		"noClientsAssociationFailure": 0
	},

	{
		"type": "clientsconnectivity",
		"baseline": 16.073205224017983,
		"standardDeviation": 12.030138051634015,
		"anomalous": false,
		"timestamp": 1520286300000,
		"observation": 14.285714285714285,
		"absoluteObservation": 1,
		"noOfSamplesForObservation": 7,
		"threshold": 0.0,
		"percentageClientsAuthFailure": 14.285714285714285,
		"noClientsAuthFailure": 1,
		"percentageClientsNetworkFailure": 0.0,
		"noClientsNetworkFailure": 0,
		"percentageClientsAssociationFailure": 0.0,
		"noClientsAssociationFailure": 0
	},
	{
		"type": "clientsconnectivity",
		"baseline": 15.214764359997073,
		"standardDeviation": 11.447855527094777,
		"anomalous": false,
		"timestamp": 1520319600000,
		"observation": 2.3255813953488373,
		"absoluteObservation": 2,
		"noOfSamplesForObservation": 86,
		"threshold": 0.0,
		"percentageClientsAuthFailure": 2.3255813953488373,
		"noClientsAuthFailure": 2,
		"percentageClientsNetworkFailure": 0.0,
		"noClientsNetworkFailure": 0,
		"percentageClientsAssociationFailure": 0.0,
		"noClientsAssociationFailure": 0
	}
]
API Calls

/V5/baselines/clientsconnectivity

Get Baseline – Clients Affected by Failures

Description This API is used to fetch the baseline data for the clients that failed due
to connectivity issues such as Authentication failure, Association failure, Network failure.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/baselines/clientsconnectivity?frequencyband=<Value>
&fromtime=<Value>&locationid=<Value>&nodeid=<Value>&ssid=<Value>
&totime=<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 clients connectivity issue. It takes an integer
    value in epoch format. Sample value, 1520275613550.

  • totime

    Is used to specify end time for clients connectivity issue. It takes an integer value
    in epoch format. Sample value, 1520319713550.

  • locationid

    Is used to specify location on which client connection failure data 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 faced
    connectivity issues. 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.

Sample code
GET https://training.mojonetworks.com/new/webservice/v5/baselines/
clientsconnectivity?frequencyband=ANY&fromtime=1520275613550&
locationid=0&nodeid=0&ssid=Spectrum-a&totime=1520319713550
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 connectivity 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.