Table of Contents
10 Graph (classic)
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Graph (classic) 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 Graph (classic) widget, please refer to the parameter behavior outlined in the tables below.
Parameters
The following parameters are supported for the Graph (classic) 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. |
|
| Source | 0 | source_type | 0 - (default) Graph; 1 - Simple graph. |
|
| Graph | 6 | graphid.0 | Graph ID. Parameter behavior: - required if Source is set to "Graph" |
|
| Graph (Widget) | 1 | graphid._reference | Instead of Graph ID:ABCDE._graphid - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for graphs.Parameter behavior: - required if Source is set to "Simple graph" and Graph is not set |
|
| Item | 4 | itemid.0 | Item ID. Parameter behavior: - required if Source is set to "Simple graph" and Item (Widget) is not set |
|
| Item (Widget) | 1 | itemid._reference | Instead of Item ID:ABCDE._itemid - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for items.Parameter behavior: - required if Source is set to "Simple graph" and Item is not set |
|
| Time period | 1 | time_period._reference | DASHBOARD._timeperiod - set the Time period selector as the data source;ABCDE._timeperiod - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source.Default: DASHBOARD._timeperiodAlternatively, you can set the time period only in the From and To parameters. |
|
| From | 1 | time_period.from | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Time period is not set |
|
| To | 1 | time_period.to | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Time period is not set |
|
| Show legend | 0 | show_legend | 0 - Disabled; 1 - (default) Enabled. |
|
| Override host | 1 | override_hostid._reference | ABCDE._hostid - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for hosts;DASHBOARD._hostid - set the dashboard Host selector as the data source for hosts.This parameter is not supported if configuring the widget on a template dashboard. |
|
| Reference | 1 | reference | Any string value consisting of 5 characters (e.g., ABCDE or JBPNL). This value must be unique within the dashboard to which the widget belongs.Parameter behavior: - required |
|
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the Graph (classic) widget. For more information on configuring a dashboard, see dashboard.create.
Configuring a Graph (classic) widget
Configure a Graph (classic) widget that displays a simple graph for the item "42269".
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graph",
"name": "Graph (classic)",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 1
},
{
"type": 4,
"name": "itemid.0",
"value": 42269
},
{
"type": 1,
"name": "reference",
"value": "RSTUV"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: