get_performance_trend_for_a_client_client_performance_trend

Client Performance Trend

Client’s performance trend can be accessed by clicking Performance on the Dashboard page. We can see the graphical representation of the client performance. The performance trend is quoted as the client health. On the dashboard, we can select the floor or folder for which we need to display the client health, it will show us the clients that have low RSSI, low data rate, high retry percentage, and those are sticky clients.

All the values on client health page can redirect to the particular client, as in we click on the Low RSSI value we can see all the clients who have low RSSI value and their details. For different values, you can see the clients particularly affected by the factor. This way you can measure the client’s performance trend.

JSON Table

Attribute Data Type Description Default/Sample Value
value long Value of the requested trend type. 0
time long Time in milliseconds. 1479893400
totalCount int Number of data points 0

Copy Sample JSON
Sample JSON
{
   "samples":[{
      "value": 125986,
      "time": 1490956200
   },
      . . .
      . . .
      . . .
   {
      "value": 67256,
      "time": 1490959800
   }],
   "totalCount": 1328842
}
API Calls

/V5/devices/clients/statistics/trend

Get Performance Trend for a Client

Description This API is used to fetch performance trend for a client.
Users with the following roles can call this API: super user, administrator, operator, and viewer.
Syntax
GET /devices/clients/statistics/trend?boxid=<value>&fromtime=<value>&totime=<value>&type=<value>&ssid=<value>&frequencyband=<value>

Here,

  • boxid

    It is used to specify the client box id for which the performance trend is required. It takes an Integer value.
    The default value is -1. It is Mandatory. To retrieve boxid refer Clients.

  • fromtime

    It is used to specify start time in epoch format. It takes an Integer value. The default value is -1.

  • totime

    It is used to specify stop time in epoch format. It takes an Integer value. The default value is -1.

  • type

    It is used to specify the type of performance trend that is required. It takes String value. Possible values are clienttraffic, clientdatarate, and clientretransmissionrate.

  • ssid

    It is used to specify a list of SSIDs for which the results should be fetched. It takes String value. To retrieve boxid refer Managed Devices call.

  • frequencyband

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

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/clients/statistics/trend?type=clienttraffic&boxid=64340
GET https://training.mojonetworks.com/new/webservice/V5/devices/clients/statistics/trend?type=clientdatarate&ssid=test-min-b&boxid=80112405
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 value and time in the application/json format.