baseline

Baseline – Clients Affected By Poor Performance(Access Point)

This API call is used to fetch Baseline data for the retry rate percentage of clients connected to the selected AP over a period of time. To fetch the data mac address of the AP is mandatory. If you need to view the baseline for the clients affected by poor performance for an AP, navigate through MONITOR–> Access Points and select an AP from the list.

JSON Table

Attribute Data Type Description
type String  It is a type of baseline.
baseline Float  It is client affected by poor performance for selected AP baseline
value for the time stamp.
standardDeviation Float  It is client affected by poor performance for selected AP standard
deviation value for the time stamp.
anomalous Boolean  This indicates if the client affected by poor performance for selected
AP baseline observation is anomalous or not.
timestamp Int  It is time stamp for current data point in epoch time format.
observation Float  It is theclient affected by poor performance for selected AP observation
value for the time stamp.
absoluteObservation Int  It is absolute value for the client affected by poor performance for
selected AP baseline observation.
noOfSamplesForObservation Int  It is no of samples considered for client affected by poor performance
for selected AP observation.
threshold Int

Copy Sample JSON
Sample JSON
[
   {
      "type":"BaselineDataPoint",
      "baseline":1.756192616838443,
      "standardDeviation":0.9529310045805144,
      "anomalous":false,
      "timestamp":1520307900000,
      "observation":0.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":140,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.7405059836845922,
      "standardDeviation":0.9609150326675954,
      "anomalous":false,
      "timestamp":1520308800000,
      "observation":0.1875293014533521,
      "absoluteObservation":4,
      "noOfSamplesForObservation":2133,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.7305763965728982,
      "standardDeviation":0.9611894695257347,
      "anomalous":false,
      "timestamp":1520309700000,
      "observation":0.7475472725151959,
      "absoluteObservation":2884,
      "noOfSamplesForObservation":385795,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.7140810749507212,
      "standardDeviation":0.9703524165324567,
      "anomalous":false,
      "timestamp":1520310600000,
      "observation":0.0810442343552004,
      "absoluteObservation":708,
      "noOfSamplesForObservation":873597,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.7058105850258338,
      "standardDeviation":0.9689889955535322,
      "anomalous":false,
      "timestamp":1520311500000,
      "observation":0.8870320824619893,
      "absoluteObservation":1913,
      "noOfSamplesForObservation":215663,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.7066009899404586,
      "standardDeviation":0.9641639518369177,
      "anomalous":false,
      "timestamp":1520312400000,
      "observation":1.7848510764883054,
      "absoluteObservation":1920,
      "noOfSamplesForObservation":107572,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.7088731219499467,
      "standardDeviation":0.9595973637753231,
      "anomalous":false,
      "timestamp":1520313300000,
      "observation":1.933814190889267,
      "absoluteObservation":807,
      "noOfSamplesForObservation":41731,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.715626636853648,
      "standardDeviation":0.9571490040483777,
      "anomalous":false,
      "timestamp":1520314200000,
      "observation":2.3842246123200703,
      "absoluteObservation":4285,
      "noOfSamplesForObservation":179723,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.7291164048086698,
      "standardDeviation":0.9617631121538435,
      "anomalous":false,
      "timestamp":1520315100000,
      "observation":3.0646034323558444,
      "absoluteObservation":3850,
      "noOfSamplesForObservation":125628,
      "threshold":0.0
   },
   {
      "type":"BaselineDataPoint",
      "baseline":1.7397631622101122,
      "standardDeviation":0.9627878229050258,
      "anomalous":false,
      "timestamp":1520316000000,
      "observation":2.7937921449529006,
      "absoluteObservation":4342,
      "noOfSamplesForObservation":155416,
      "threshold":0.0
   }]
API Calls

/V5/baselines/apretryrate

Get Baseline – Clients Affected By Poor Performance(Access Point)

Description This API is used to fetch the baseline data for the retry rate percentage of clients
connected to the selected AP. To fetch this data mac-address of AP is mandatory.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/baselines/apretryrate?macaddress=<Value>
frequencyband=<Value>&fromtime=<Value>&locationid=<Value>
&nodeid=<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 to selected AP. It takes an integer value
    in epoch format. Sample value, 1520284126746.

  • totime

    Is used to specify end time for clients connected to selected AP. It takes an integer
    value in epoch format. Sample value, 1520328226746.

  • locationid

    Is used to specify location on which retry rate for clients has to be calculated.
    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.

  • macaddress

    It is used to specify mac-address of the AP. This is a mandatory query parameter.
    It takes a string value. Sample value, 00:11:74:F8:0A:3F.

Sample code
GET https://training.mojonetworks.com/new/webservice/v5/baselines/
apretryrate?CID=ATN9&frequencyband=5&fromtime=1520284126746&locationid=4
&macaddress=00:11:74:F8:0A:3F&nodeid=0&totime=1520328226746
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 baseline data points for clients connected to the selected AP.
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.