Table of Contents
dashboard.get
Description
integer/array dashboard.get(object parameters)
The method allows to retrieve dashboards according to the given parameters.
Parameters
(object) Parameters defining the desired output.
The method supports the following parameters.
| Parameter | Type | Description |
|---|---|---|
| dashboardids | string/array | Return only dashboards with the given IDs. |
| selectWidgets | query | Return the dashboard widgets that are used in the dashboard with in widgets property. |
| selectUsers | query | Returns users that the dashboard is shared with in users property. |
| selectUserGroups | query | Returns user groups that the dashboard is shared with in userGroups property. |
| sortfield | string/array | Sort the result by the given properties. Possible value is: dashboardid. |
| countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary page. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Return values
(integer/array) Returns either:
- an array of objects;
- the count of retrieved objects, if the
countOutputparameter has been used.
Examples
Retrieving a dashboard by ID
Retrieve all data about dashboards "1" and "2".
Request:
{ "jsonrpc": "2.0", "method": "dashboard.get", "params": { "output": "extend", "selectWidgets": "extend", "selectUsers": "extend", "selectUserGroups": "extend", "dashboardids": [ "1", "2" ] }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
{ "jsonrpc": "2.0", "result": [ { "dashboardid": "1", "name": "Dashboard", "userid": "1", "private": "0", "users": [], "userGroups": [], "widgets": [ { "widgetid": "9", "type": "stszbx", "name": "", "x": "6", "y": "8", "width": "6", "height": "5", "fields": [] }, { "widgetid": "8", "type": "syssum", "name": "", "x": "6", "y": "4", "width": "6", "height": "4", "fields": [] }, { "widgetid": "7", "type": "hoststat", "name": "", "x": "6", "y": "0", "width": "6", "height": "4", "fields": [] }, { "widgetid": "6", "type": "dscvry", "name": "", "x": "3", "y": "9", "width": "3", "height": "4", "fields": [] }, { "widgetid": "5", "type": "webovr", "name": "", "x": "0", "y": "9", "width": "3", "height": "4", "fields": [] }, { "widgetid": "4", "type": "problems", "name": "", "x": "0", "y": "3", "width": "6", "height": "6", "fields": [] }, { "widgetid": "3", "type": "favmap", "name": "", "x": "4", "y": "0", "width": "2", "height": "3", "fields": [] }, { "widgetid": "2", "type": "favscr", "name": "", "x": "2", "y": "0", "width": "2", "height": "3", "fields": [] }, { "widgetid": "1", "type": "favgrph", "name": "", "x": "0", "y": "0", "width": "2", "height": "3", "fields": [] } ] }, { "dashboardid": "2", "name": "My dashboard", "userid": "1", "private": "1", "users": [ { "userid": "4", "permission": "3" } ], "userGroups": [ { "usrgrpid": "7", "permission": "2" } ], "widgets": [ { "widgetid": "10", "type": "problems", "name": "", "x": "0", "y": "0", "width": "6", "height": "5", "fields": [ { "type": "2", "name": "groupids", "value": "4" } ] } ] } ], "id": 1 }See also
Source
CDashboard::get() in frontends/php/include/classes/api/services/CDashboard.php.