API - Dashboard list
To get a list of all panels, you must perform a GET request on the URL like this: http://192.168.1.1/api/dashboards.
To obtain information about a particular dashboard, you must perform a following GET request on a URL 'http://192.168.1.1/api/graphs/12' . Here "12" is the ID of the desired graph.
In the headers, it is necessary to pass API key. For example:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Also, in the headers, you must specify the desired data exchange format. Currently, only the JSON format is supported.
Accept: application/json Content-Type: application/json
An example of querying a list of dashboards:
URL: http://192.168.1.1/api/dashboards
Method: GET
Headers:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Example of response:
[ { "id": "1", "title": "Упаковка", "hide_title": "0", "width": "900", "height": "450" }, { "id": "2", "title": "Расход воды", "hide_title": "1", "width": "1024", "height": "800" } ]
Example of requesting information on dashboard number 1:
URL: http://192.168.1.1/api/dashboards/1
Method: GET
Headers:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Example of reply:
{ "id": "1", "title": "Упаковка", "hide_title": "0", "width": "900", "height": "450" }
Dashboards attributes:
id | int | Unique dashboard identifier |
title | string | Dashboard name |
hide_title | int | 0 = display dashboard name , 1 = hide dashboard name |
width | int | Working area width in pixels |
height | int | Working area height in pixels |