baseline

Baseline – Data Rate

Baseline- Data Rate calculates the baseline of the average data rate consumed by an individual client over a period of time. If you want to view the baseline graph of data rate against the globally configured threshold just navigate to Performance–> Client health.

JSON Table

Attribute Data Type Description
type String  It is a type of baseline.
baseline Float  It is baseline data rate value for the time stamp.
standardDeviation Float  It is baseline datarate standard deviation value for the time stamp.
anomalous Boolean  This indicates if the baseline datarate observation is anomalous or
not.
timestamp Int  It is time stamp for current data point in epoch time format.
observation Float  It is the baseline datarate observation value for the time stamp.
absoluteObservation Int  It is absolute value for the data rate baseline observation.
noOfSamplesForObservation Int  It is no of samples considered for baseline datarate observation.
threshold Float
ssid String  Name of SSId where client is connected.
frequencyBand Enum  It is used to specify frequency band. Possible values are 2.4GHz, 5GHz
and ANY. Default value is ANY.

Copy Sample JSON
Sample JSON 
[
   {
      "type":"clientdatarate",
      "baseline":669933.0,
      "standardDeviation":322039.0,
      "anomalous":false,
      "timestamp":1520316000000,
      "observation":888066.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":667870.0,
      "standardDeviation":321081.0,
      "anomalous":false,
      "timestamp":1520316900000,
      "observation":463693.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":664671.0,
      "standardDeviation":321052.0,
      "anomalous":false,
      "timestamp":1520317800000,
      "observation":348035.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":661819.0,
      "standardDeviation":320699.0,
      "anomalous":false,
      "timestamp":1520318700000,
      "observation":379552.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":663476.0,
      "standardDeviation":319517.0,
      "anomalous":false,
      "timestamp":1520319600000,
      "observation":827541.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum-a",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":665693.0,
      "standardDeviation":318679.0,
      "anomalous":false,
      "timestamp":1520320500000,
      "observation":885184.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum-a",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":667870.0,
      "standardDeviation":317821.0,
      "anomalous":false,
      "timestamp":1520321400000,
      "observation":883455.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum-a",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":661379.0,
      "standardDeviation":322755.0,
      "anomalous":true,
      "timestamp":1520322300000,
      "observation":18807.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum-a",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":652671.0,
      "standardDeviation":326831.0,
      "anomalous":false,
      "timestamp":1520324100000,
      "observation":445450.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum-a",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":649825.0,
      "standardDeviation":326423.0,
      "anomalous":false,
      "timestamp":1520325000000,
      "observation":368089.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum-a",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":652185.0,
      "standardDeviation":325634.0,
      "anomalous":false,
      "timestamp":1520325900000,
      "observation":885844.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum-a",
      "frequencyBand":"BAND_5_GHZ"
   },
   {
      "type":"clientdatarate",
      "baseline":654265.0,
      "standardDeviation":324662.0,
      "anomalous":false,
      "timestamp":1520326800000,
      "observation":860279.0,
      "absoluteObservation":0,
      "noOfSamplesForObservation":0,
      "threshold":20.0,
      "ssid":"Spectrum-a",
      "frequencyBand":"BAND_5_GHZ"
   }
]
API Calls
Get

/V5/baselines/clientdatarate

Get Baseline – Data Rate

Description This API is used to fetch the baseline data for the average data rate consumed by
an individual client over a period of time. To fetch this data mac-address of client
is mandatory.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/baselines/clientdatarate?macaddress=<Value>&fromtime=<Value>
&locationid=<Value>&nodeid=<Value>&totime=<Value>

Here,

  • fromtime

    Is used to specify start time for clients data rate over a period of time.
    It takes an integer value in epoch format. Sample value, 1520311784233.

  • totime

    Is used to specify end time for clients data rate over a period of time.
    It takes an integer value in epoch format. Sample value, 1520327084233.

  • locationid

    Is used to specify location on which data 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 client. This is a mandatory
    query parameter. It takes a string value. Sample value, 80:E6:50:26:5B:CE.
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/baselines/clientdatarate?
fromtime=1520311784233&locationid=26&macaddress=80:E6:50:26:5B:CE&nodeid=0&
totime=1520327084233
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 data rate. 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.