clients_by_data_buckets

Client’s by Data Buckets

Clients are segregated into buckets on the basis of the data rate. Mojo Aware already has some pre-defined fixed threshold values for Average Data Rate. Since threshold can be configured, the user may select a value that falls in between on the X-axis on the graph. The user needs to set the data rate threshold value and RSSI value. If the clients that are in the bucket have their threshold value to fall then it is displayed in yellow. Parameters like bucketsize  and startvalue of the buckets are specified. The type of the bucket is also mentioned that can be either- rfcoverage, percentageretransimission, and averagedatarate.

JSON Table

Attribute Data Type Description
samples application/json
samples/start long Start value of a bucket for the specified tpye.
samples/end long End value of a bucket for the specified type.
samples/value long Number of clients falling in the bucket.
totalCount int Total number of clients across all buckets.

Copy Sample JSON
Sample JSON 
{
	"samples": [{
		"start-85,
		"end": -75,
		"value": 1
	}, {
		"start": -65,
		"end": -45,
		"value": 1
	}, 
	. . .
	. . .
	. . .
	{
		"start": -45,
		"end": -35,
		"value": 3
	}],
	"totalCount": 9
}
API Calls
Get

/V5/devices/clients/bucket

Get Clients by Data Buckets

Description This API is used to fetch clients segregated into buckets based on the specified type.
Users with the following roles can call this API: super user, administrator, operator, and viewer.
Syntax
GET <Base_URL>/devices/clients/bucket?type=<value>&startvalue=<value>&bucketsize=<value>&frequencyband=<value>&bssids=<value>&manageddeviceboxid=<value>&ssid=<value>

Here,

  • type

    It is used to specify bucket type. Possible values are rfcoverage, percentageretransmission, and averagedatarate. It takes String value. It is a mandatory field.

  • startvalue

    It is used to specify Start value of the buckets. It takes an Integer value.

  • bucketsize

    It is used to specify the size of each bucket. It takes an Integer value. The default value is 10.

  • frequencyband

    It is used to specify frequency band. Possible values are 2.4, 5 and ANY
    (default).

  • bssids

    It is used to specify an optional filter for the list of macaddresses. It takes String Value.

  • manageddeviceboxid

    It is used to specify the optional filter for managed device boxid. It takes an Integer value. To fetch the appropriate boxid refer Managed Devices call.

  • ssid

    It is used to specify the list of SSIDs for which the results should be returned. It takes String value. To fetch the list of SSIDs refer Get SSIDs Configured on a Managed Device.
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/clients/bucket?type=rfcoverage
GET https://training.mojonetworks.com/new/webservice/V5/devices/clients/bucket?type=rfcoverage&ssid=test-min-b
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 the client’s statistics divided into buckets of the desired type. The response is in the application/json format.