You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

3 Data overview

This widget is deprecated and will be removed in the upcoming major release. Consider using the Top hosts widget instead.

Description

These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Data overview widget in dashboard.create and dashboard.update methods.

Widget fields properties are not validated during the creation or update of a dashboard. This allows users to modify built-in widgets and create custom widgets, but also introduces the risk of creating or updating widgets incorrectly. To ensure the successful creation or update of the Data overview widget, please refer to the parameter behavior outlined in the tables below.

Parameters

The following parameters are supported for the Data overview widget.

Parameter type name value
Refresh interval 0 rf_rate 0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - (default) 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.
Host groups 2 groupids.0 Host group ID.

Note: To configure multiple host groups, create a dashboard widget field object for each host group with an incremented number in the property name.

This parameter is not supported if configuring the widget on a template dashboard.
Host groups (Widget) 1 groupids._reference Instead of Host group ID:
ABCDE._hostgroupids - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for host groups.

This parameter is not supported if configuring the widget on a template dashboard.
Hosts 3 hostids.0 Host ID.

Note: To configure multiple hosts, create a dashboard widget field object for each host with an incremented number in the property name. For multiple hosts, the parameter Host groups must either be not configured at all or configured with at least one host group that the configured hosts belong to.

This parameter is not supported if configuring the widget on a template dashboard.
Hosts (Widget/Dashboard) 1 hostids._reference Instead of Host ID:
DASHBOARD.hostids - set the Host selector as the data source for hosts;
ABCDE._hostids - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for hosts.

This parameter is not supported if configuring the widget on a template dashboard.
Item tags
Evaluation type 0 evaltype 0 - (default) And/Or;
2 - Or.
Tag name 1 tags.0.tag Any string value.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Item tags
Operator 0 tags.0.operator 0 - Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Item tags
Tag value 1 tags.0.value Any string value.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Item tags
Show suppressed problems 0 show_suppressed 0 - (default) Disabled;
1 - Enabled.
Hosts location 0 style 0 - (default) Left;
1 - Top.

Examples

The following examples aim to only describe the configuration of the dashboard widget field objects for the Data overview widget. For more information on configuring a dashboard, see dashboard.create.

Configuring a Data overview widget

Configure a Data overview widget that displays data for host "10084" and only for items for which the tag with the name "component" contains value "cpu". In addition, display the data with hosts located on top.

Request:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "dataover",
                               "name": "Data overview",
                               "x": 0,
                               "y": 0,
                               "width": 36,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 3,
                                       "name": "hostids.0",
                                       "value": 10084
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.0.tag",
                                       "value": "component"
                                   },
                                   {
                                       "type": 0,
                                       "name": "tags.0.operator",
                                       "value": 0
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.0.value",
                                       "value": "cpu"
                                   },
                                   {
                                       "type": 0,
                                       "name": "style",
                                       "value": 1
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "3"
               ]
           },
           "id": 1
       }

See also