Baseline Latency

This call gives the average latency time taken by the authenticated servers like DHCP, DNS, AAA, and Network servers associated with the clients that are present in a selected folder or floor. For the call the type of latency needs to be specified- AAA, DHCP, DNS, WAN, and the frequency band is mentioned.

JSON Table

Attribute Data Type Description
baseline float It is average latency baseline value for the time stamp.
standardDeviation float It is average latency standard deviation value for the time stamp.
anomalous boolean This indicates if the average latency observation is anomalous or not.
timestamp int It is time stamp for current data point in epoch time format.
observation float It is the average latency observation value for the time stamp.
absoluteObservation int It is absolute value for the latency observation.
noOfSamplesForObservation int It is no of samples considered for average latency observation.
threshold float
numberOfClientsNewlyConnected int It is a number of client newly connected at the time. This is only applicable for AAA, DNS, DHCP latency type.

Copy Sample JSON
Sample JSON 
 [{
      "baseline":16.832946882827446,
      "standardDeviation":22.435697811893622,
      "anomalous":false,
      "timestamp":1520355600000,
      "observation":2.5,
      "absoluteObservation":5,
      "noOfSamplesForObservation":2,
      "threshold":0.0,
      "numberOfClientsNewlyConnected":6
   },
   {
      "baseline":16.68461741399917,
      "standardDeviation":22.37197113453589,
      "anomalous":false,
      "timestamp":1520356500000,
      "observation":2.0,
      "absoluteObservation":2,
      "noOfSamplesForObservation":1,
      "threshold":0.0,
      "numberOfClientsNewlyConnected":1
   },
   {
      "baseline":16.541104573192513,
      "standardDeviation":22.30558313813439,
      "anomalous":false,
      "timestamp":1520357400000,
      "observation":2.3333333333333335,
      "absoluteObservation":14,
      "noOfSamplesForObservation":6,
      "threshold":0.0,
      "numberOfClientsNewlyConnected":10
   },
   {
      "baseline":16.415693527460586,
      "standardDeviation":22.228826191449446,
      "anomalous":false,
      "timestamp":1520358300000,
      "observation":4.0,
      "absoluteObservation":16,
      "noOfSamplesForObservation":4,
      "threshold":0.0,
      "numberOfClientsNewlyConnected":7
   },
   {
      "baseline":16.782445683095073,
      "standardDeviation":22.416416170605054,
      "anomalous":false,
      "timestamp":1520359200000,
      "observation":53.09090909090909,
      "absoluteObservation":584,
      "noOfSamplesForObservation":11,
      "threshold":0.0,
      "numberOfClientsNewlyConnected":6
   },
   {
      "baseline":17.014621226264122,
      "standardDeviation":22.423367267120355,
      "anomalous":false,
      "timestamp":1520360100000,
      "observation":40.0,
      "absoluteObservation":160,
      "noOfSamplesForObservation":4,
      "threshold":0.0,
      "numberOfClientsNewlyConnected":2
   }
  ]
API Calls
Get

/V5/baselines/latencies/{type}

Get Baseline Latency

Description This API is used to fetch the average latency time taken by the authentication servers
like DHCP, DNS, AAA and Network servers associated with the clients that are present on
a selected folder or floor.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/v5/baselines/latencies/{type}?frequencyband=<Value>
&fromtime=<Value>&locationid=<Value>&nodeid=<Value>&totime=<Value>

Here,

  • type

    Type of the latency. Possible values are

    • AAA
    • DHCP
    • DNS
    • WAN
  • 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 client connections for which average latency baseline
    data is to be fetched. It takes an integer value in epoch format. Sample value, 1520354914831.

  • totime

    Is used to specify start time for client connections for
    which average latency baseline data is to be fetched. It takes an integer value in epoch format.
    Sample value, 1520399014831.

  • locationid

    Is used to specify location on which average latency baseline
    data is to be fetched. It takes an integer value.

  • nodeid

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

  • wanlatencytype

    It is used to specify WAN latency type. This query parameter is only
    applicable for WAN latency type. Applicable values are:

    • wired
    • wireless
    • both
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/baselines/latencies/AAA?
CID=ATN9&frequencyband=ANY&fromtime=1520354914831&locationid=0&nodeid=0&
totime=1520399014831

 

GET https://training.mojonetworks.com/new/webservice/v5/baselines/latencies/DHCP?
CID=ATN9&frequencyband=ANY&fromtime=1520355352423&locationid=0&nodeid=0&
totime=1520399452423

 

GET https://training.mojonetworks.com/new/webservice/v5/baselines/latencies/DNS?
CID=ATN9&frequencyband=ANY&fromtime=1520355437415&locationid=0&nodeid=0&
totime=1520399537415

 

GET https://training.mojonetworks.com/new/webservice/v5/baselines/latencies/WAN?
CID=ATN9&frequencyband=ANY&fromtime=1520355244632&locationid=0&nodeid=0&
totime=1520399344632&wanlatencytype=both
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 latency 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.