inactive
369
edits
REST API description: Difference between revisions
→List queries
| Line 67: | Line 67: | ||
==== List queries ==== | ==== List queries ==== | ||
List queries are requested with pagination parameters to reduce the size of the resulting JSON | List queries are requested with pagination parameters to reduce the size of the resulting JSON objects and to increase performance. In the resulting JSON object, the list elements are stored in the displayedItems array. | ||
The following list parameters are possible: | |||
* sort: Sorting criteria for the list. Following criterias are supported for most lists: | * sort: Sorting criteria for the list. Following criterias are supported for most lists: | ||
** bytes: Received and transmitted bytes (either in selected time interval or since start of the Multimeter) | ** bytes: Received and transmitted bytes (either in selected time interval or since start of the Multimeter). | ||
** rxbytes: Received bytes | ** rxbytes: Received bytes. | ||
** txbytes: Transmitted bytes | ** txbytes: Transmitted bytes. | ||
** bps: Received and transmitted bytes per second (either average per second value of the selected time interval or last second, if no interval is specified) | ** bps: Received and transmitted bytes per second (either average per second value of the selected time interval or last second, if no interval is specified). | ||
** rxbps: Received bytes per second | ** rxbps: Received bytes per second. | ||
** txbps: Transmitted bytes per second | ** txbps: Transmitted bytes per second. | ||
* reverse: Sort ascending (= false) or descending (= true) | * reverse: Sort ascending (= false) or descending (= true). | ||
* page: Requested page. | * page: Requested page. | ||
* count: Amount of entries in the list. Maximum is 100. | * count: Amount of entries in the list. Maximum is 100. | ||
* values: Amount of maximal values in history object | * values: Amount of maximal values in history object(s). | ||
==== Show IP address with the highest amount of traffic ==== | ==== Show IP address with the highest amount of traffic ==== | ||