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.

Parametertypenamevalue
Refresh interval0rf_rate0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - (default) 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.
Recipients11useridsUser ID.

Note: To configure multiple users, create a dashboard widget field object for each user.
Actions12actionidsAction ID.

Note: To configure multiple actions, create a dashboard widget field object for each action.
Media types13mediatypeidsMedia type ID.

Note: To configure multiple media types, create a dashboard widget field object for each media type.
Status0statuses0 - In progress;
1 - Sent/Executed;
2 - Failed.

Note: To configure multiple values, create a dashboard widget field object for each value.
Search string1messageAny string value.
Sort entries by0sort_triggers3 - 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 lines0show_linesValid 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.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "dashboard.create",
  4.            "params": {
  5.                "name": "My dashboard",
  6.                "display_period": 30,
  7.                "auto_start": 1,
  8.                "pages": [
  9.                    {
  10.                        "widgets": [
  11.                            {
  12.                                "type": "actionlog",
  13.                                "name": "Action log",
  14.                                "x": 0,
  15.                                "y": 0,
  16.                                "width": 12,
  17.                                "height": 5,
  18.                                "view_mode": 0,
  19.                                "fields": [
  20.                                    {
  21.                                        "type": 0,
  22.                                        "name": "show_lines",
  23.                                        "value": 10
  24.                                    },
  25.                                    {
  26.                                        "type": 0,
  27.                                        "name": "sort_triggers",
  28.                                        "value": 3
  29.                                    },
  30.                                    {
  31.                                        "type": 11,
  32.                                        "name": "userids",
  33.                                        "value": 1
  34.                                    },
  35.                                    {
  36.                                        "type": 13,
  37.                                        "name": "mediatypeids",
  38.                                        "value": 1
  39.                                    },
  40.                                    {
  41.                                        "type": 0,
  42.                                        "name": "statuses",
  43.                                        "value": 2
  44.                                    }
  45.                                ]
  46.                            }
  47.                        ]
  48.                    }
  49.                ],
  50.                "userGroups": [
  51.                    {
  52.                        "usrgrpid": 7,
  53.                        "permission": 2
  54.                    }
  55.                ],
  56.                "users": [
  57.                    {
  58.                        "userid": 1,
  59.                        "permission": 3
  60.                    }
  61.                ]
  62.            },
  63.            "id": 1
  64.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "dashboardids": [
  5.                    "3"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

See also