> Dashboard object

The following objects are directly related to the dashboard API.

The dashboard object has the following properties.

Property	Type	Description
dashboardid	string	ID of the dashboard. Property behavior: - read-only - required for update operations
name	string	Name of the dashboard. Property behavior: - required for create operations
userid	string	Dashboard owner user ID.
private	integer	Type of dashboard sharing. Possible values: 0 - public dashboard; 1 - (default) private dashboard.
display_period	integer	Default page display period (in seconds). Possible values: 10, 30, 60, 120, 600, 1800, 3600. Default: 30.
auto_start	integer	Auto start slideshow. Possible values: 0 - do not auto start slideshow; 1 - (default) auto start slideshow.

The dashboard page object has the following properties.

Property	Type	Description
dashboard_pageid	string	ID of the dashboard page. Property behavior: - read-only
name	string	Dashboard page name. Default: empty string.
display_period	integer	Dashboard page display period (in seconds). Possible values: 0, 10, 30, 60, 120, 600, 1800, 3600. Default: 0 (will use the default page display period).
widgets	array	Array of the dashboard widget objects.

The dashboard widget object has the following properties.

Property	Type	Description
widgetid	string	ID of the dashboard widget. Property behavior: - read-only
type	string	Type of the dashboard widget. Possible values: actionlog - Action log; clock - Clock; (deprecated) dataover - Data overview; discovery - Discovery status; favgraphs - Favorite graphs; favmaps - Favorite maps; geomap - Geomap; graph - Graph (classic); graphprototype - Graph prototype; hostavail - Host availability; item - Item value; map - Map; navtree - Map Navigation Tree; plaintext - Plain text; problemhosts - Problem hosts; problems - Problems; problemsbysv - Problems by severity; slareport - SLA report; svggraph - Graph; systeminfo - System information; tophosts - Top hosts; trigover - Trigger overview; url - URL; web - Web monitoring. Property behavior: - required
name	string	Custom widget name.
x	integer	A horizontal position from the left side of the dashboard. Valid values range from 0 to 23.
y	integer	A vertical position from the top of the dashboard. Valid values range from 0 to 62.
width	integer	The widget width. Valid values range from 1 to 24.
height	integer	The widget height. Valid values range from 2 to 32.
view_mode	integer	The widget view mode. Possible values: 0 - (default) default widget view; 1 - with hidden header;
fields	array	Array of the dashboard widget field objects. Property behavior: - see individual widgets in Dashboard widget fields

The dashboard widget field object has the following properties.

Property	Type	Description
type	integer	Type of the widget field. Possible values: 0 - Integer; 1 - String; 2 - Host group; 3 - Host; 4 - Item; 5 - Item prototype; 6 - Graph; 7 - Graph prototype; 8 - Map; 9 - Service; 10 - SLA; 11 - User; 12 - Action; 13 - Media type. Property behavior: - required
name	string	Widget field name. Possible values: see Dashboard widget fields. Property behavior: - required
value	mixed	Widget field value depending on the type. Possible values: see Dashboard widget fields. Property behavior: - required

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

Property	Type	Description
usrgrpid	string	User group ID. Property behavior: - required
permission	integer	Type of permission level. Possible values: 2 - read only; 3 - read-write. Property behavior: - required

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

Property	Type	Description
userid	string	User ID. Property behavior: - required
permission	integer	Type of permission level. Possible values: 2 - read only; 3 - read-write. Property behavior: - required

Documentation