Adds an Alert Analysis tab to the XLSX output document.
Compatibility
The macro can be used in the highlighted input document types only. A greyed-out icon indicates not supported.
Usage
Does not work in Report Studio. More details about alert macros can be found at https://docs.magicsuite.net/ReportMagic/Macros/LogicMonitor. The default columns output into the XLSX file are: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'Count', 'FractionalCount' and 'AffectedGroupCount'. This macro intentionally fails if the date range is greater than 3 months, for memory and performance reasons.
Updates
A pivot table value field that cannot be understood is now reported as a warning rather than being ignored in silence. Reports still run and their output is unchanged; the macro is flagged with a warning naming the field, so a mistyped field can be seen rather than having to be noticed as a missing column.
History (2)
A pivot table field name that does not match any column in the data now produces a warning naming it and the available columns, instead of being silently ignored.
The analysis pivot table can now be customised (column, filter, row and value fields).
Behaviour (2)11 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Int32 | Optional | The maximum number of attempts when requesting data via the LogicMonitor API. |
|
N/A | |
| Boolean | Optional | Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses). |
|
N/A |
Additional (11)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used. |
|
false | |
| List<ExecutionResult> | Optional | If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: 'Unknown', 'Success', 'MacroError', 'WorkerStopped', 'Running', 'Warning', 'NeverRun', 'Cancelled', 'Pending', 'Paused', 'SystemError', 'Deferred' and 'Stopped'. |
|
N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| String | Optional | If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type. | N/A | N/A | |
| String | Optional | If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared. | N/A | N/A | |
| String | Optional | The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z')". | N/A | true | |
| MacroMode | Optional | The mode in which variables are stored. In legacy mode (default for Schedules), the variable created is a string and formatted. In normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a JArray etc., rather than a formatted string. |
|
Legacy | |
| ObfuscationType | Optional | Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen. |
|
None | |
| Boolean | Optional | Whether to recurse device groups. Specify true to include alerts from child device groups. |
|
true | |
| Boolean | Optional | Whether to use the cache (where supported). |
|
false | |
| String | Optional | If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression. | N/A | N/A |
Time & Date (3)
| Parameter | Type | Presence | Purpose | Options | Default |
| DateTimeOffset | Optional | The end date in the format YYYY-MM-DD. | N/A | Midnight on the first day of this month | |
| Int32 | Optional | If set, sets 'endDate' to the 'start' plus the specified number of months. | N/A | N/A | |
| DateTimeOffset | Optional | The start date in the format YYYY-MM-DD. | N/A | Midnight on the first day of last month |
Filtering & Sorting (6)6 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Whether to exclude alerts for Resources that no longer exist in the portal (based on Resource ID). This has no effect unless useCache=true (as Resources removed from LogicMonitor automatically causes their alerts to be deleted). |
|
false | |
| List<String> | Optional | The full paths of the groups to exclude. | N/A | N/A | |
| Boolean | Optional | Whether to include the Alert body. |
|
false | |
| Boolean | Optional | Whether to include the Alert subject. |
|
false | |
| AlertLevel | Optional | The Alert level. |
|
Warning | |
| List<String> | Optional | The pivot table filter fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Filters' section. You an use any of the heading names: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'FractionalCount' and 'AffectedGroupCount'. | N/A | N/A |
Additional (6)
| Parameter | Type | Presence | Purpose | Options | Default |
| AckFilter | Optional | All: Both non-acknowledged alerts and acknowledged alerts will be returned. Acked: Alerts that have been acknowledged will be returned. Nonacked: Alerts that have not been acknowledged will be returned. |
|
All | |
| Boolean | Optional | true: Historical alert records will be returned (i.e. both active and inactive alert details). false: Only active alert details will be returned. |
|
true | |
| String | Optional | The order the alerts should be retrieved in. | N/A | StartOnSeconds | |
| OrderDirection | Optional | The direction of the order the alerts should be retrieved in. |
|
Desc | |
| Int32 | Optional | The number of items to skip. | N/A | N/A | |
| Int32 | Optional | The maximum number to take. | N/A | N/A |
Output (1)2 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The name to use for the analytics worksheet (which will contain the pivot table and chart). The data worksheet (which will contain the 'fact table') uses this name plus the suffix ' Data'. If a worksheet by this name already exists, the new name will have a number appended, e.g. Analytics1, Analytics2, etc. Excel does not allow blank names, names above 31 characters, and the following characters: :, /, \, ?, *, [, ]. | N/A | Alert Analytics |
Additional (2)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message. | N/A | N/A | |
| String | Optional | The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message. | N/A | N/A |
General (7)20 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Whether to add a title to the Analytics worksheet. |
|
true | |
| Boolean | Optional | Whether to add column grand totals to the pivot table. |
|
true | |
| List<String> | Optional | The pivot table column fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Columns' section. You an use any of the heading names: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'FractionalCount' and 'AffectedGroupCount'. | N/A | N/A | |
| List<String> | Optional | The pivot table row fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Rows' section. You an use any of the heading names: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'FractionalCount' and 'AffectedGroupCount'. | N/A | N/A | |
| List<String> | Optional | The pivot table value fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Values' section. For each column name, you can specify the aggregation to use via the ^ character e.g. column1^Sum. Omit this to use the default Count aggregation. Valid aggregation values are: 'Average', 'Count', 'CountNumbers', 'Max', 'Min', 'Product', 'StdDev', 'StdDevP', 'Sum', 'Var' or 'VarP'. For each column name, if and only if you have specified an aggregation, you can also specify the number format to use in the pivot table and chart. To do this, use an additional caret separator and specify the number format. For example: column1^Sum^0.00 would use 2 decimal places for the format. You an use any of the heading names: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'FractionalCount' and 'AffectedGroupCount'. | N/A | N/A | |
| List<String> | Optional | For each resource / website property specified (auto, custom, inherited or system properties), this includes the property name as a header in the XLSX 'fact' worksheet, and its value when present (otherwise empty). Note: the macro may take significantly longer to run in this case. | N/A | N/A | |
| Boolean | Optional | Whether to add row grand totals to the pivot table. |
|
false |
Additional (20)
| Parameter | Type | Presence | Purpose | Options | Default |
| Int32 | Conditional | Only include alerts relating to a LogicModule with this Id. WARNING! Multiple LogicModules could have the same Id. Only use with useCache=true. | N/A | N/A | |
| Regex | Optional | If present, only alerts with acknowledgement comments matching the regular expression are included. | N/A | N/A | |
| List<String> | Optional | The semicolon-separated list of alertTypes to fetch. Options are: 'AlertThrottled', 'BatchJob', 'CollectorDown', 'CollectorFailBack', 'CollectorFailover', 'DataSource', 'EventSource', 'Log', 'ResourceCluster', 'Unknown' or 'Website'. | N/A | N/A | |
| String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
| String | Optional | The name of the Connection. | N/A | N/A | |
| String | Optional | The name of the dataPoint that you want to retrieve alert data for. | N/A | N/A | |
| String | Optional | The DataSource unique name. | N/A | N/A | |
| String | Optional | The Datasource Instance e.g. WinVolumeUsage-F: | N/A | N/A | |
| String | Optional | The specific unique alert ID to fetch. | N/A | N/A | |
| Int32 | Optional | Filter alerts where the alert has been active for more than the specified number of minutes. | N/A | N/A | |
| String | Optional | The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. | N/A | N/A | |
| Int32 | Optional | Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary. | N/A | N/A | |
| MonitorObjectType | Optional | Determines whether the monitored object in question is a Device or a Website, when specifying the Monitor Object ID and 'useCache=false'. This is necessary because there are specific LogicMonitor API calls to fetch alerts that are used in each case, in order to ensure that, for example, a Device that has had its name changed can still be queried for all alerts by its ID. Just specifying the Monitor Object ID alone is insufficient to determine the type. |
|
Device | |
| String | Optional | Only include alerts matching this problem signature (InternalId). | N/A | N/A | |
| String | Optional | Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder. | N/A | N/A | |
| String | Optional | Only include alerts relating to a LogicModule with this **Display Name** (NOT unique name). WARNING! Multiple LogicModules (even of the same type) could have the same display name. | N/A | N/A | |
| Regex | Optional | If present, only alerts with a resource template name matching the regular expression are included. | N/A | N/A | |
| SdtFilter | Optional | Filter alerts by SDT status where SDT means only include alerts created during SDT in the results, NonSdt means only include alerts created outside SDT in the results and All shows all alerts. |
|
All | |
| Int32 | Optional | DEPRECATED | N/A | N/A | |
| String | Optional | DEPRECATED | N/A | N/A |
Deprecated (5)14 additional
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| List<String> | pivotTableColumnFields | The pivot table column fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Columns' section. You an use any of the heading names: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'FractionalCount' and 'AffectedGroupCount'. | N/A | N/A | |
| Boolean | excludeDeletedResources | Whether to exclude alerts for Resources that no longer exist in the portal (based on Resource ID). This has no effect unless useCache=true (as Resources removed from LogicMonitor automatically causes their alerts to be deleted). |
|
false | |
| List<String> | pivotTableFilterFields | The pivot table filter fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Filters' section. You an use any of the heading names: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'FractionalCount' and 'AffectedGroupCount'. | N/A | N/A | |
| List<String> | pivotTableRowFields | The pivot table row fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Rows' section. You an use any of the heading names: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'FractionalCount' and 'AffectedGroupCount'. | N/A | N/A | |
| List<String> | pivotTableValueFields | The pivot table value fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Values' section. For each column name, you can specify the aggregation to use via the ^ character e.g. column1^Sum. Omit this to use the default Count aggregation. Valid aggregation values are: 'Average', 'Count', 'CountNumbers', 'Max', 'Min', 'Product', 'StdDev', 'StdDevP', 'Sum', 'Var' or 'VarP'. For each column name, if and only if you have specified an aggregation, you can also specify the number format to use in the pivot table and chart. To do this, use an additional caret separator and specify the number format. For example: column1^Sum^0.00 would use 2 decimal places for the format. You an use any of the heading names: 'AckComment', 'Acked', 'AckedBy', 'AckedOnUtc', 'Active', 'AlertRecipients', 'AlertRuleId', 'AlertRuleName', 'AlertType', 'Body', 'ClearValue', 'DataPoint', 'DataSourceId', 'DataSourceName', 'DataSourceInstance', 'DataSourceInstanceDescription', 'DataSourceInstanceId', 'GroupLevel1', 'GroupLevel2', 'GroupLevel3', 'GroupLevel4', 'GroupLevel5', 'GroupFullPath', 'ResourceId', 'ResourceName', 'EndOnUtc', 'EndOnUtcDate', 'EndOnUtcDateDayOfWeek', 'EndOnUtcDateHourOfDay', 'EscalationChainId', 'EscalationChainName', 'EscalationSubChainId', 'Id', 'InScheduledDownTime', 'Level', 'NextRecipient', 'StartOnUtc', 'StartOnUtcDate', 'StartOnUtcDateDayOfWeek', 'StartOnUtcDateHourOfDay', 'Subject', 'Thresholds', 'InternalId', 'Value', 'DurationGroup', 'DurationString', 'DurationMinutes', 'FractionalCount' and 'AffectedGroupCount'. | N/A | N/A |
Additional (14)
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| List<String> | alertTypes | The semicolon-separated list of alertTypes to fetch. Options are: 'AlertThrottled', 'BatchJob', 'CollectorDown', 'CollectorFailBack', 'CollectorFailover', 'DataSource', 'EventSource', 'Log', 'ResourceCluster', 'Unknown' or 'Website'. | N/A | N/A | |
| Int32 | monitorObjectId | Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary. | N/A | N/A | |
| String | dataSourceInstance | The Datasource Instance e.g. WinVolumeUsage-F: | N/A | N/A | |
| String | dataSource | The DataSource unique name. | N/A | N/A | |
| String | monitorObjectDisplayName | The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. | N/A | N/A | |
| String | resourceGroupName | Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder. | N/A | N/A | |
| Int32 | monitorObjectId | Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary. | N/A | N/A | |
| String | monitorObjectDisplayName | The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. | N/A | N/A | |
| SdtFilter | sdted | Filter alerts by SDT status where SDT means only include alerts created during SDT in the results, NonSdt means only include alerts created outside SDT in the results and All shows all alerts. |
|
All | |
| String | resourceGroupName | Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder. | N/A | N/A | |
| String | monitorObjectDisplayName | The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. | N/A | N/A | |
| String | problemSignature | Only include alerts matching this problem signature (InternalId). | N/A | N/A | |
| Int32 | take | The maximum number to take. | N/A | N/A | |
| Int32 | monitorObjectId | Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary. | N/A | N/A |
Examples (3)
Example 1Normal mode
This Normal Mode example fetches all Alerts with a level of error for the specific Resource Group (historically known as a Device Group) and sets a custom worksheet name:
[LogicMonitor.DeviceGroupList: mode=Normal, deviceGroups=/, recurseDeviceGroups=true, property=FullPath, =>A, orderBy=Description][Json.List: jArray=`{A}`, jsonPath="$.[0].FullPath", =>DeviceFullPath]
*** [String: value={DeviceFullPath}] *** : [LogicMonitor.AlertAnalysis: worksheetName=My Analytics Worksheet, level=Error, resourceGroupName={DeviceFullPath}, failureText=No info]Example 2Normal mode
This Normal Mode example adds additional columns to the source data worksheet (the 'fact' worksheet) to insert the value of the system property 'system.collectorid' and a custom property 'customer.code':
[LogicMonitor.DeviceGroupList: mode=Normal, deviceGroups=/, recurseDeviceGroups=true, property=FullPath, =>A, orderBy=Description][Json.List: jArray=`{A}`, jsonPath="$.[0].FullPath", =>DeviceFullPath]
*** [String: value={DeviceFullPath}] *** : [LogicMonitor.AlertAnalysis: level=Error, resourceGroupName={DeviceFullPath}, resourceProperties=system.collectorid;customer.code, failureText=No info]Example 3Normal mode
This Normal Mode example customises and sets up the pivot table in the analysis worksheet:
[LogicMonitor.DeviceGroupList: mode=Normal, deviceGroups=/, recurseDeviceGroups=true, property=FullPath, =>A, orderBy=Description][Json.List: jArray=`{A}`, jsonPath="$.[0].FullPath", =>DeviceFullPath]
*** [String: value={DeviceFullPath}] *** : [LogicMonitor.AlertAnalysis: level=Error, resourceGroupName={DeviceFullPath}, pivotTableColumnFields=AckedBy, pivotTableFilterFields=Acked, pivotTableRowFields=AckedOnUtc;Active, pivotTableValueFields=Acked, failureText=No info]