Baseline – Clients Affected – Wi-Fi API Documentation

Baseline – Clients Affected

This call generates the total number of clients that are affected due to various issues- both low RSSI and Low Data Rate. Such clients would then appear in both categories. Mojo Aware ensures that such clients aren’t counted twice. It displays the total number of distinct clients affected by the issues that are mentioned.

JSON Table

Attribute	Data Type	Description
type	String	It is a type of baseline.
baseline	Float	It is client affected baseline value for the time stamp.
standardDeviation	Float	It is client affected standard deviation value for the time stamp.
anomalous	Boolean	This indicates if the client affected by poor application experience 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 application experience observation value for the time stamp.
absoluteObservation	Int	It is absolute value for the client affected by poor application experience observation.
noOfSamplesForObservation	Int	It is no of samples considered for client connectivity affected observation.
threshold	Float

Sample JSON

[{
  "type": "BaselineDataPoint",
  "baseline": 82.26976303249504,
  "standardDeviation": 33.881140096481836,
  "anomalous": false,
  "timestamp": 1520315100000,
  "observation": 100.0,
  "absoluteObservation": 1,
  "noOfSamplesForObservation": 1,
  "threshold": 0.0
},
 {
  "type": "BaselineDataPoint",
  "baseline": 82.7963688006669,
  "standardDeviation": 33.50964738098558,
  "anomalous": false,
  "timestamp": 1520317800000,
  "observation": 100.0,
  "absoluteObservation": 2,
  "noOfSamplesForObservation": 2,
  "threshold": 0.0
}, 
{
  "type": "BaselineDataPoint",
  "baseline": 82.96840511266022,
  "standardDeviation": 33.385589042186986,
  "anomalous": false,
  "timestamp": 1520318700000,
  "observation": 100.0,
  "absoluteObservation": 1,
  "noOfSamplesForObservation": 1,
  "threshold": 0.0
}, 

 {
  "type": "BaselineDataPoint",
  "baseline": 82.81807272821216,
  "standardDeviation": 33.01308395875346,
  "anomalous": false,
  "timestamp": 1520325000000,
  "observation": 100.0,
  "absoluteObservation": 1,
  "noOfSamplesForObservation": 1,
  "threshold": 0.0
}, 

 {
  "type": "BaselineDataPoint",
  "baseline": 83.32839315011154,
  "standardDeviation": 32.649678892526296,
  "anomalous": false,
  "timestamp": 1520327700000,
  "observation": 100.0,
  "absoluteObservation": 2,
  "noOfSamplesForObservation": 2,
  "threshold": 0.0
}]

API Calls

Get

/V5/baselines/clientsaffectedbypoorappquality

Get Baseline – Clients Affected

Description	This API is used to fetch the baseline data for the clients affected by poor application experience. Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax	GET <Base_URL>/baselines/clientsaffectedbypoorappquality? frequencyband=<Value>&fromtime=<Value>&locationid=<Value> &nodeid=<Value>&applicationcategory=<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 application experience. It takes an integer value in epoch format. Sample value, 1520284516583. totime Is used to specify end time for baseline data of clients affected by poor application experience. It takes an integer value in epoch format. Sample value, 1520328616583. locationid Is used to specify location on which baseline data for clients affected by poor application experience 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. applicationcategory It is used to specify category of an application. It takes a string value. Sample value, VOIP. macaddress It is used to specify mac-address of the clients. It takes a string value. Sample value, 00:11:74:F8:0A:3F.
Sample code	GET https://training.mojonetworks.com/new/webservice/v5/baselines/ clientsaffectedbypoorappquality?applicationcategory=VOIP&frequencyband=5 &fromtime=1520284516583&locationid=4&macaddress=00:11:74:F8:0A:3F&nodeid=0 &totime=1520328616583
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 application experience 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.

Understand Arista Cloud Architecture

Know what Arista APIs can do

Know how Arista APIs work?

API Reference

Baseline – Clients Affected