Sidebar

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.
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).

Request:

{
           "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
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

See also