Documentation
Table of Contents
1 Action log
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Action log widget in dashboard.create and dashboard.update methods.
Parameters
The following parameters are supported for the Action log 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. |
| Recipients | 11 | userids | User ID. Note: To configure multiple users, create a dashboard widget field object for each user. |
| Actions | 12 | actionids | Action ID. Note: To configure multiple actions, create a dashboard widget field object for each action. |
| Media types | 13 | mediatypeids | Media type ID. Note: To configure multiple media types, create a dashboard widget field object for each media type. |
| Status | 0 | statuses | 0 - In progress; 1 - Sent/Executed; 2 - Failed. Note: To configure multiple values, create a dashboard widget field object for each value. |
| Search string | 1 | message | Any string value. |
| Sort entries by | 0 | sort_triggers | 3 - Time (ascending); 4 - (default) Time (descending); 5 - Type (ascending); 6 - Type (descending); 7 - Status (ascending); 8 - Status (descending); 11 - Recipient (ascending); 12 - Recipient (descending). |
| Show lines | 0 | show_lines | Valid values range from 1-100. Default: 25. |
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the Action log widget. For more information on configuring a dashboard, see dashboard.create.
Configuring an Action log widget
Configure an Action log widget that displays 10 entries of action operation details, sorted by time (in ascending order). In addition, display details only for those action operations that attempted to send an email to user "1", but were unsuccessful.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "actionlog",
"name": "Action log",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "show_lines",
"value": 10
},
{
"type": 0,
"name": "sort_triggers",
"value": 3
},
{
"type": 11,
"name": "userids",
"value": 1
},
{
"type": 13,
"name": "mediatypeids",
"value": 1
},
{
"type": 0,
"name": "statuses",
"value": 2
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: