[comment]: # translation:outdated

[comment]: # ({a79e0e24-a79e0e24})
# > Dashboard object

A következő objektumok közvetlenül kapcsolódnak az „irányítópult” API-hoz.

[comment]: # ({/a79e0e24-a79e0e24})

[comment]: # ({467bb7e6-63e4049e})
### Dashboard

The dashboard object has the following properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|dashboardid|string|*(readonly)* ID of the dashboard.|
|**name**<br>(required)|string|Name of the dashboard.|
|userid|string|Dashboard owner user ID.|
|private|integer|Type of dashboard sharing.<br><br>Possible values:<br>0 - public dashboard;<br>1 - *(default)* private dashboard.|
|display\_period|integer|Default page display period (in seconds).<br><br>Possible values: 10, 30, 60, 120, 600, 1800, 3600.<br><br>Default: 30.|
|auto\_start|integer|Auto start slideshow.<br><br>Possible values:<br>0 - do not auto start slideshow;<br>1 - *(default)* auto start slideshow.|

Note that for some methods (update, delete) the required/optional parameter combination is different.

[comment]: # ({/467bb7e6-63e4049e})

[comment]: # ({0a3c01dc-b88f0a6a})
### Dashboard page

The dashboard page object has the following properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|dashboard\_pageid|string|*(readonly)* ID of the dashboard page.|
|name|string|Dashboard page name.<br><br>Default: empty string.|
|display\_period|integer|Dashboard page display period (in seconds).<br><br>Possible values: 0, 10, 30, 60, 120, 600, 1800, 3600.<br><br>Default: 0 (will use the default page display period).|
|widgets|array|Array of the [dashboard widget](object#dashboard_widget) objects.|

[comment]: # ({/0a3c01dc-b88f0a6a})

[comment]: # ({22d29c0e-2938b685})
### Dashboard widget

The dashboard widget object has the following properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|widgetid|string|*(readonly)* ID of the dashboard widget.|
|**type**<br>(required)|string|Type of the dashboard widget.<br><br>Possible values:<br>actionlog - Action log;<br>clock - Clock;<br>dataover - Data overview;<br>discovery - Discovery status;<br>favgraphs - Favorite graphs;<br>favmaps - Favorite maps;<br>graph - Graph (classic);<br>graphprototype - Graph prototype;<br>hostavail - Host availability;<br>item - Item value;<br>map - Map;<br>navtree - Map Navigation Tree;<br>plaintext - Plain text;<br>problemhosts - Problem hosts;<br>problems - Problems;<br>problemsbysv - Problems by severity;<br>slareport - SLA report;<br>svggraph - Graph;<br>systeminfo - System information;<br>tophosts - Top hosts;<br>trigover - Trigger overview;<br>url - URL;<br>web - Web monitoring.|
|name|string|Custom widget name.|
|x|integer|A horizontal position from the left side of the dashboard.<br><br>Valid values range from 0 to 23.|
|y|integer|A vertical position from the top of the dashboard.<br><br>Valid values range from 0 to 62.|
|width|integer|The widget width.<br><br>Valid values range from 1 to 24.|
|height|integer|The widget height.<br><br>Valid values range from 2 to 32.|
|view\_mode|integer|The widget view mode.<br><br>Possible values:<br>0 - (default) default widget view;<br>1 - with hidden header;|
|fields|array|Array of the [dashboard widget field](object#dashboard_widget_field) objects.|

[comment]: # ({/22d29c0e-2938b685})

[comment]: # ({f40455ad-5b20bc04})
### Dashboard widget field

The dashboard widget field object has the following properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**type**<br>(required)|integer|Type of the widget field.<br><br>Possible values:<br>0 - Integer;<br>1 - String;<br>2 - Host group;<br>3 - Host;<br>4 - Item;<br>5 - Item prototype;<br>6 - Graph;<br>7 - Graph prototype;<br>8 - Map;<br>9 - Service;<br>10 - SLA.|
|name|string|Widget field name.|
|**value**<br>(required)|mixed|Widget field value depending of type.|

[comment]: # ({/f40455ad-5b20bc04})

[comment]: # ({a310f35f-5c8b3411})
### Dashboard user group

List of dashboard permissions based on user groups. It has the following
properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**usrgrpid**<br>(required)|string|User group ID.|
|**permission**<br>(required)|integer|Type of permission level.<br><br>Possible values:<br>2 - read only;<br>3 - read-write;|

[comment]: # ({/a310f35f-5c8b3411})

[comment]: # ({dfa3f2d2-d34afa0c})
### Dashboard user

List of dashboard permissions based on users. It has the following
properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**userid**<br>(required)|string|User ID.|
|**permission**<br>(required)|integer|Type of permission level.<br><br>Possible values:<br>2 - read only;<br>3 - read-write;|

[comment]: # ({/dfa3f2d2-d34afa0c})