Table of Contents
25 SLA report
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the SLA report 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 SLA report widget, please refer to the parameter behavior outlined in the tables below.
Parameters
The following parameters are supported for the SLA report widget.
| Parameter | type | name | value |
|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - (default) No refresh; 10 - 10 seconds; 30 - 30 seconds; 60 - 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
| SLA | 10 | slaid.0 | SLA ID. Parameter behavior: - required |
| Service | 9 | serviceid.0 | Service ID. |
| Show periods | 0 | show_periods | Possible values range from 1-100. Default: 20. |
| From | 1 | date_from | Valid date string in format YYYY-MM-DD.Relative dates with modifiers d, w, M, y (e.g. now, now/d, now/w-1w, etc.) are supported. |
| To | 1 | date_to | Valid date string in format YYYY-MM-DD.Relative dates with modifiers d, w, M, y (e.g. now, now/d, now/w-1w, etc.) are supported. |
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the SLA report widget. For more information on configuring a dashboard, see dashboard.create.
Configuring an SLA report widget
Configure an SLA report widget that displays the SLA report for SLA "4" service "2" for the period of last 30 days.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "slareport",
"name": "SLA report",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 10,
"name": "slaid.0",
"value": 4
},
{
"type": 9,
"name": "serviceid.0",
"value": 2
},
{
"type": 1,
"name": "date_from",
"value": "now-30d"
},
{
"type": 1,
"name": "date_to",
"value": "now"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: