Quick StartThe ReportMagic MenuSchedulesBatch JobsReport StudioFilesProfileAdminAccount DetailsMeraki WebHooksGetting StartedAbout ReportMagicRegistering and Logging InSearching ReportMagicConnections and AgentsWriting ReportsStarting Out With Report StudioCreating Report TemplatesRMScriptMacro ShorthandReporting on Different Periods of TimeSetting Macro Parameter DefaultsStoring Input and Output FilesReport VariablesUsing Variable ParametersSpecifying How Graphs LookStep-by-Step LogicMonitor Graph ExamplesStep-by-Step Jira Graph ExamplesSpecifying How Tables LookChanging Fonts and ColorsUsing Macros in PowerPoint TemplatesRestricted MacrosGenerating Reports Using SchedulesUsing HTML Forms in SchedulesSeeing How Reports RanViewing ReportsCached ValuesUsing AggregationsAdvanced Report StudioAPI AccessREST APIREST API - FilesAdvancedRole-Based Access Control (RBAC)SecurityMiscellaneousBadgesCertificationsTips, Tricks and Shortcut KeysMacrosAgentAgent.ConnectionAgent.ExecuteAgent.MonitorMagicNodeListAgent.MonitorMagicNodeMeasurementListAgent.MonitorMagicNodeMeasurementSummaryAgent.MonitorMagicNodePropertyListAgent.MonitorMagicNodeTypeListAgent.PropertyAgent.SqlAnalysisAgent.SqlGraphAgent.SqlListAgent.SqlTableAgent.SqlValueAgent.SqlValuesAgent.WebQueryAlertMagicAlertMagic.MetricsGraphAlertMagic.MetricsListAutoTaskAutoTask.AccountListAutoTask.AccountPropertyAutoTask.ConnectionAutoTask.CountAutoTask.FieldListAutoTask.FieldPropertyAutoTask.ListAutoTask.PropertyAutoTask.SummaryValueAutoTask.TicketListAutoTask.TicketPropertyAzureAzure.ConnectionAzure.LogAnalyticsGraphAzure.LogAnalyticsQueryAzure.LogAnalyticsScalarAzure.LogAnalyticsTableAzure.ResourceGroupListAzure.ResourceListAzure.ResourcePropertiesAzure.SentinelAlertRuleListAzure.SentinelConnectorListAzure.SentinelIncidentListAzure.SentinelThreatIndicatorListAzure.SentinelThreatIndicatorMetricListAzure.SubscriptionListBloggerBlogger.BlogPropertyBlogger.ConnectionBlogger.PageBlogger.PageListBlogger.PagePropertyBlogger.PostBlogger.PostListBlogger.PostPropertyCacheCache.ExpiresCache.GetCache.IsSetCache.SetCache.UnsetCertifyCertify.ConnectionCertify.DepartmentListCertify.DepartmentPropertyCherwellCherwell.BusinessObjectDefinitionListCherwell.BusinessObjectListCherwell.BusinessObjectSchemaCherwell.BusinessObjectSummaryCherwell.ConnectionCiscoCisco.ConnectionCisco.FirmwareVersionPropertyCisco.SecurityAdvisoryListCisco.SerialNumberPropertyCisco.SoftwareSuggestionListCiscoDnaCenterCiscoDnaCenter.ConnectionCiscoDnaCenter.SiteListCiscoDnaCenter.SitePropertyCloudHealthCloudHealth.AssetDetailsCloudHealth.AssetListCloudHealth.AvailableReportDimensionsCloudHealth.AvailableReportOptionsCloudHealth.AvailableReportsListCloudHealth.AwsAccountDetailsCloudHealth.AwsAccountsListCloudHealth.ConnectionCloudHealth.CustomerDetailsCloudHealth.CustomerListCloudHealth.CustomerReportDetailsCloudHealth.CustomerStatementDetailsCloudHealth.OrganisationAccountsListCloudHealth.OrganisationListCloudHealth.QueryConnectWiseManageConnectWiseManage.ConnectionConnectWiseManage.CountConnectWiseManage.DictionaryConnectWiseManage.ListConnectWiseManage.PropertyCoreArrayArray.CountBreakBreakpointCalculateColorCommentContinueConvertDeleteDeleteRowDocumentBookmarkDocumentBreakDocumentInsertSectionDocumentSectionEmailEmailFileEmailReportExecuteForEachFormatTableCellFormatTableRowIfIgnoreIncInsertTableCellImageIsSetLinearRegressionLinkMapObjectRandomRegexRepeatRowSearchAndReplaceSectionSettingsSleepStopStopwatchStringStringIndexSubstringSwitchThrowExceptionUnsetWarningDatabaseDatabase.ConnectionDatabase.GraphDatabase.ListDatabase.TableDatabase.ValueDatabase.ValuesDataMagicDataMagic.SyncDictionaryDictionary.ItemDictionary.KeysDictionary.ValuesDocumentDocument.SetPropertiesFileFile.CopyFile.CopyOutputFilesFile.Csv.CellFile.Csv.RowFile.Csv.RowCountFile.Csv.TableFile.EmbedFile.ExecuteFile.ExistsFile.ImageFile.InsertFile.ListFile.LoadListFile.LoadObjectFile.LoadStringFile.LoadVariablesFile.Xlsx.CellFile.Xlsx.RowFile.Xlsx.RowCountFile.Xlsx.TableFunctionFunction.CallFunction.DefineGoogleGoogle.ConnectionGoogle.TableGraphGraph.AddDataGraph.DeleteDataGraph.RenameDataGraph.UpdateGravatarGravatar.ImageHighlightHighlight.BearerSummaryHighlight.BroadbandSummaryHighlight.CellularSummaryHighlight.ConnectionHighlight.FolderListHighlight.HttpServerPerformanceSummaryHighlight.IcmpTcpUdpPerformanceSummaryHighlight.MosPerformanceSummaryHighlight.PrecisionPerformanceSummaryHighlight.TunnelSummaryHighlight.WatchNodeListHighlight.WirelessAccessPointSummaryHubSpotHubSpot.ListJarrayJarray.TableJiraJira.AttachmentImageJira.AttachmentListJira.AttachmentPropertyJira.ConnectionJira.GraphJira.InsertMarkupJira.IssueAnalysisJira.IssueCommentListJira.IssueCommentPropertyJira.IssueLastCommentPropertyJira.IssueListJira.IssuePropertyJira.IssueResponseTimeJira.LastImageJira.StatusListJira.TableJira.TimeInStateJira.UserListJira.UserPropertyJsonJson.ItemJson.ListKrokiKroki.ImageListList.AddList.AnalysisList.ComplementList.CountList.DequeueList.DuplicatesList.FirstList.GraphList.GroupByList.IndicesOfList.IntersectionList.ItemList.RangeList.SelectList.SelectColumnsList.SortList.SummaryValueList.TableList.UnionList.WhereLogicMonitorLogicMonitor.AccountPropertyLogicMonitor.AlertAnalysisLogicMonitor.AlertCalendarLogicMonitor.AlertCountLogicMonitor.AlertListLogicMonitor.AlertMapLogicMonitor.AlertPropertyLogicMonitor.AlertRuleListLogicMonitor.AlertRulePropertyLogicMonitor.AlertStatusLogicMonitor.AlertTableLogicMonitor.AppliesToFunctionListLogicMonitor.AppliesToFunctionPropertyLogicMonitor.AppliesToListLogicMonitor.AuditEventAnalysisLogicMonitor.BigNumberWidgetValuesLogicMonitor.ClearCacheLogicMonitor.CollectorExecuteLogicMonitor.CollectorGroupListLogicMonitor.CollectorGroupPropertyLogicMonitor.CollectorListLogicMonitor.CollectorPropertyLogicMonitor.CollectorVersionListLogicMonitor.CollectorVersionPropertyLogicMonitor.ConfigCheckListLogicMonitor.ConfigCheckPropertyLogicMonitor.ConfigSourceGroupListLogicMonitor.ConfigSourceListLogicMonitor.ConfigSourcePropertyLogicMonitor.ConfigSourceXmlLogicMonitor.ConnectionLogicMonitor.ConnectionApiTokenLogicMonitor.ConvertToLiveWidgetLogicMonitor.DashboardLogicMonitor.DashboardGroupListLogicMonitor.DashboardGroupPropertyLogicMonitor.DashboardListLogicMonitor.DashboardPropertyLogicMonitor.DashboardWidgetListLogicMonitor.DatamartSyncLogicMonitor.DataPointListLogicMonitor.DataPointPropertyLogicMonitor.DataSourceGraphListLogicMonitor.DataSourceGraphPropertyLogicMonitor.DataSourceGroupListLogicMonitor.DataSourceListLogicMonitor.DataSourcePropertyLogicMonitor.DataSourceXmlLogicMonitor.DeviceConfigSourceFileLogicMonitor.DeviceConfigSourceInstanceListLogicMonitor.DeviceConfigSourceListLogicMonitor.DeviceConfigSourcePropertyLogicMonitor.DeviceCountLogicMonitor.DeviceDataSourceListLogicMonitor.DeviceDataSourcePropertyLogicMonitor.DeviceGroupListLogicMonitor.DeviceGroupPropertyLogicMonitor.DeviceListLogicMonitor.DevicePropertyLogicMonitor.DeviceSlaWidgetPropertyLogicMonitor.DeviceTableLogicMonitor.EscalationChainDestinationListLogicMonitor.EscalationChainDestinationPropertyLogicMonitor.EscalationChainListLogicMonitor.EscalationChainPropertyLogicMonitor.EventSourceFilterListLogicMonitor.EventSourceFilterPropertyLogicMonitor.EventSourceGroupListLogicMonitor.EventSourceListLogicMonitor.EventSourcePropertyLogicMonitor.EventSourceXmlLogicMonitor.FinancialInformationLogicMonitor.ForecastLogicMonitor.GraphLogicMonitor.HistoricSdtListLogicMonitor.ImageLogicMonitor.InstanceAnalysisLogicMonitor.InstanceCountLogicMonitor.InstanceDetailsTableLogicMonitor.InstanceGroupCountLogicMonitor.InstanceGroupListLogicMonitor.InstanceListLogicMonitor.InstancePropertyLogicMonitor.IntegrationListLogicMonitor.IntegrationPropertyLogicMonitor.JobMonitorListLogicMonitor.JobMonitorPropertyLogicMonitor.LastMeasurementLogicMonitor.LogAnalysisLogicMonitor.LogicModuleMetadataPropertyLogicMonitor.LogicModuleUpdateListLogicMonitor.LogicModuleUpdatePropertyLogicMonitor.LogItemListLogicMonitor.NetscanGroupListLogicMonitor.NetscanGroupPropertyLogicMonitor.NetscanListLogicMonitor.NetscanPropertyLogicMonitor.NewUserMessagePropertyLogicMonitor.PaymentInformationLogicMonitor.PercentageAvailabilityLogicMonitor.PortalVersionLogicMonitor.PropertySourceGroupListLogicMonitor.PropertySourceJsonLogicMonitor.PropertySourceListLogicMonitor.PropertySourcePropertyLogicMonitor.QueryLogicMonitor.RecipientGroupListLogicMonitor.RecipientGroupPropertyLogicMonitor.RecycleBinItemListLogicMonitor.RecycleBinItemPropertyLogicMonitor.ReportGroupListLogicMonitor.ReportGroupPropertyLogicMonitor.ReportListLogicMonitor.ReportPropertyLogicMonitor.ResourceAnalysisLogicMonitor.ResourceGroupAnalysisLogicMonitor.RoleListLogicMonitor.RolePropertyLogicMonitor.SdtListLogicMonitor.SdtPercentageLogicMonitor.SdtPropertyLogicMonitor.SingleSignOnPropertyLogicMonitor.SlaWidgetValuesLogicMonitor.SnmpSysOidMapListLogicMonitor.SnmpSysOidMapPropertyLogicMonitor.SummaryValueLogicMonitor.SummaryValueListLogicMonitor.ThresholdLogicMonitor.TrafficTableLogicMonitor.UnmonitoredDeviceListLogicMonitor.UnmonitoredDevicePropertyLogicMonitor.UserApiTokenListLogicMonitor.UserApiTokenPropertyLogicMonitor.UserListLogicMonitor.UserPropertyLogicMonitor.WebsiteCheckpointDataListLogicMonitor.WebsiteCountLogicMonitor.WebsiteGroupAnalysisLogicMonitor.WebsiteGroupCountLogicMonitor.WebsiteGroupListLogicMonitor.WebsiteGroupPropertyLogicMonitor.WebsiteListLogicMonitor.WebsitePropertyLogicMonitor.WidgetStatusMagicSuiteMagicSuite.SubscriptionListMerakiMeraki.CameraImageMeraki.ConfigurationChangeListMeraki.ConnectionMeraki.DevicePropertyMeraki.DeviceUplinkPropertyMeraki.EndOfLifeMeraki.NetworkClientListMeraki.NetworkDeviceListMeraki.NetworkEventListMeraki.NetworkListMeraki.NetworkPropertyMeraki.NetworkSwitchPortsListMeraki.NetworkSwitchStackListMeraki.OrganizationDeviceLicenseListMeraki.OrganizationDeviceLicensePropertyMeraki.OrganizationDeviceListMeraki.OrganizationDeviceListStatusPropertyMeraki.OrganizationInventoryListMeraki.OrganizationLicenseStatePropertyMeraki.OrganizationListMeraki.OrganizationPropertyMeraki.OrganizationUplinkUsageMeraki.WirelessNetworkClientConnectionStatsPropertyMeraki.WirelessNetworkClientLatencyListMeraki.WirelessNetworkClientsConnectionStatsListMeraki.WirelessNetworkClientsLatencyListMeraki.WirelessNetworkConnectionStatsPropertyMeraki.WirelessNetworkDeviceConnectionStatsPropertyMeraki.WirelessNetworkDeviceLatencyListMeraki.WirelessNetworkDevicesConnectionStatsListMeraki.WirelessNetworkDevicesLatencyListMeraki.WirelessNetworkLatencyListMicrosoftDataverseMicrosoftDataverse.ConnectionMicrosoftDataverse.CountMicrosoftDataverse.EntityDefinitionsListMicrosoftDataverse.EntityListMicrosoftDataverse.EntityPropertyListMicrosoftDataverse.ListMicrosoftDataverse.PropertyMicrosoftGraphMicrosoftGraph.ConnectionMicrosoftGraph.MicrosoftDataverseConnectionMicrosoftGraph.QueryObjectObject.ArrayCountObject.PropertyObject.TypeObject.UnpackObject.UnpackVariablesOpenAiOpenAi.AnswerOpenAi.CompleteOpenAi.ConnectionOpenAi.ImageQuickBooksQuickBooks.ConnectionQuickBooks.PropertyReportMagicReportMagic.ApplyBrandReportMagic.BadgeListReportMagic.ConnectionListReportMagic.ConnectionPropertyReportMagic.ConnectionStatusPropertyReportMagic.FeedbackListReportMagic.FeedbackPropertyReportMagic.MacroGroupListReportMagic.MacroHelpReportMagic.MacroListReportMagic.ReportBatchJobCountReportMagic.ReportBatchJobListReportMagic.ReportBatchJobPropertyReportMagic.ReportConnectionSummaryReportMagic.ReportJobCountReportMagic.ReportJobListReportMagic.ReportJobPropertyReportMagic.ReportMacroCountReportMagic.ReportPropertyReportMagic.ReportScheduleCountReportMagic.ReportScheduleListReportMagic.ReportSchedulePropertyReportMagic.SetReportPropertyReportMagic.SystemPropertyReportMagic.TenantImageReportMagic.TopicHelpReportMagic.VersionSalesforceSalesforce.ConnectionSalesforce.ListSalesforce.PropertyServiceNowServiceNow.ConnectionServiceNow.CountServiceNow.CreateServiceNow.DeleteServiceNow.DictionaryServiceNow.ListServiceNow.PropertyServiceNow.UpdateShapeShape.AddShape.CloneShape.DeleteShape.FormatShape.HideShape.SetPropertyShape.SetTextSlackSlack.ConnectionSlack.MessageSlideSlide.DeleteSlide.DeleteSectionSlide.LinkSlide.MoveToSlide.RepeatSmtpSmtp.ConnectionSnmpSnmp.EnterprisePropertySolarWindsSolarWinds.ConnectionSolarWinds.SqlListSolarWinds.SqlTableSqlSql.AnalysisTableTable.ColumnCountTable.DeleteTable.FormatTable.GraphTable.MergeCellsTable.RowCountTable.SaveTable.SortTable.WorldMapTimeCalendarCronHumanReadableCronRunDateDateRangeDateTimeDateTime.IsInWorkHoursDateTime.WorkHoursDurationTimeSpanTogglToggl.ClientListToggl.ClientPropertyToggl.ConnectionToggl.ProjectListToggl.ProjectPropertyToggl.ProjectReportPropertyToggl.TimeEntryListToggl.TimeEntryPropertyToggl.UserListToggl.UserPropertyToggl.WorkspaceListToggl.WorkspacePropertyTwilioTwilio.ConnectionTwilio.SmsUkParliamentUkParliament.PetitionCountUkParliament.PetitionListUkParliament.PetitionPropertyVariableVariable.ImageVariable.ListVariable.PropertyWebWeb.ConnectionWeb.HtmlWeb.ImageWeb.QueryWeb.ScreenshotWeb.TableWeb.TextXlsxXlsx.AddAnalysisXlsx.EmbedZendeskZendesk.ConnectionZendesk.ListZendesk.PropertyZoho.DeskZoho.Desk.ZohoListZoho.Desk.ZohoProperty

[LogicMonitor.AlertTable:]

Creates a table of alerts that were active in the reporting period.


Purpose

Creates a table of alerts that were active in the reporting period. Note: The number of days for which alert data is retained in LogicMonitor varies according to whether you have a STANDARD, PRO, ENTERPRISE, MSP STANDARD or MSP PARTNER LogicMonitor set up. For some packages, alerts are only kept for 30 days, so please ensure that you are on one of the packages that keeps alerts for 60 days or more. For more information, check with your LogicMonitor account manager. More details about alert macros can be found at https://reportmagic.blogspot.com/p/reportmagic-alert-macros.html For the take parameter, there is a limit of 300. If your results will be 300 or more, set the take parameter in your macro to 299. You can then do a second macro where you use the skip parameter to skip 299 and take the next 299.


Macro Compatibility

The macro can be used in all input document types and in Report Studio.


Usage

The following columns are supported by the columns parameter (note that some are identical):

  • AckComment : The acknowledgement comment, if acknowledged, otherwise "None". Empty if not acknowledged
  • Acked: Whether the alert is acknowledged (True or False)
  • AckedBy: The username of the user that acknowledged the alert, otherwise "None". Empty if not acknowledged
  • AckedOn: When the alert was acknowledged (UTC), otherwise "None"
  • AckedOnLocal: When the alert was acknowledged (local time), otherwise "None"
  • AckedOnUtc: When the alert was acknowledged (UTC), otherwise "None"
  • Active: Whether the alert is active (True or False)
  • AlertEscalationChainName: The name of the escalation chain name if applicable (otherwise an empty string)
  • AlertRule: The alert rule if applicable (otherwise an empty string)
  • AlertRuleName: The alert rule name if applicable (otherwise an empty string)
  • AlertType: The type of the alert (usually Alert)
  • Body: The alert body from the "detail message"
  • DataPoint: The datapoint whose threshold has been breached
  • DataSource: The dataSource whose threshold has been breached
  • DataSourceId: The ID of the dataSource whose threshold has been breached
  • DataSourceInstance: The dataSource instance whose threshold has been breached
  • DataSourceInstanceId: The ID of the dataSource instance whose threshold has been breached
  • Duration: The duration of the alert in human-readable form (the duration at the time the report was generated if the alert is still active)
  • DurationSeconds: The duration of the alert in seconds (the duration at the time the report was generated if the alert is still active)
  • DurationMinutes: The duration of the alert in minutes (the duration at the time the report was generated if the alert is still active)
  • DurationHours: The duration of the alert in hours (the duration at the time the report was generated if the alert is still active)
  • DurationDays: The duration of the alert in days (the duration at the time the report was generated if the alert is still active)
  • Device: The device name
  • DeviceId The device ID
  • DeviceName: The device name
  • DisplayName: The device name
  • EndOn: The time the alert was cleared (UTC), otherwise "None"
  • EndOnLocal: The time the alert was cleared (local time), otherwise "None"
  • EndOnUtc: The time the alert was cleared (UTC), otherwise "None"
  • Host: The device name
  • HostId: The device ID
  • Id: The alert ID
  • Level: The Alert level (Warning, Error or Critical)
  • StartOn: The time the alert was created (UTC)
  • StartOnLocal: The time the alert was created (local time)
  • StartOnUtc: The time the alert was created (UTC)
  • Subject: The alert subject from the "detail message"
  • Thresholds: The alert thresholds that have been breached
  • Value: The value that triggered the alert

See also Table Macros help.


Parameter TypeDeprecation Message Preferred ParameterPresence Purpose Options Default
level
AlertLevelConditional Only include alerts at this level or above.
  • Error
  • All
  • Warning
  • Critical
  • DoMapping
  • Any
Error
resourceTemplateId
Int32Conditional 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
ackCommentMatchesRegex
RegexOptional If present, only alerts with acknowledgement comments matching the regular expression are included. N/A N/A
ackFilter
AckFilterOptional 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
  • Acked
  • Nonacked
All
alertType
List<String>DeprecatedalertTypes 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
alertTypes
List<String>

Use instead of:

  • alertType
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
alignment
List<String>DeprecatedcolumnAlignments The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. N/A N/A
alignments
List<String>DeprecatedcolumnAlignments The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. N/A N/A
auto
BooleanOptional If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used.
  • true
  • false
false
autofit
AutoFitBehaviorDeprecatedautoFit The Word autofit behaviour. If omitted, no change is made.
  • Content
  • Fixed
  • Window
Content
autoFit
AutoFitBehavior

Use instead of:

  • autofit
Optional The Word autofit behaviour. If omitted, no change is made.
  • Content
  • Fixed
  • Window
Content
collectorId
Int32DeprecatedmonitorObjectId 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
columnAlignments
List<String>

Use instead of:

  • alignment
  • alignments
Optional The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. N/A N/A
columns
List<String>Optional The column names to show. If the columns parameter is not specified, the Macro's default will be used. N/A N/A
comment
StringOptional Add a comment to make your document template more readable. The comment is discarded in the output document. N/A N/A
connectionName
StringOptional The name of the Connection. N/A N/A
criticalCellColor
ColorOptional The critical cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=192, G=0, B=0]
criticalCellTextColor
ColorOptional The critical cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
dataPoint
StringOptional The name of the dataPoint that you want to retrieve alert data for. N/A N/A
dataSource
String

Use instead of:

  • dataSourceName
Optional The DataSource unique name. N/A N/A
dataSourceInstance
String

Use instead of:

  • dataSourceInstanceName
Optional The Datasource Instance e.g. WinVolumeUsage-F: N/A N/A
dataSourceInstanceName
StringDeprecateddataSourceInstance The Datasource Instance e.g. WinVolumeUsage-F: N/A N/A
dataSourceName
StringDeprecateddataSource The DataSource unique name. N/A N/A
dateTimeFormat
StringOptional The format of data/time columns. For example: MM/dd/yyyy. N/A yyyy-MM-dd HH:mm:ss
deCamelCaseHeaderRow
BooleanOptional Whether to de-camel-case the header row (i.e. convert 'MyHeaderText' to 'My Header Text'.
  • true
  • false
false
device
StringDeprecatedmonitorObjectDisplayName The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. N/A N/A
deviceGroup
StringDeprecatedresourceGroupName 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
deviceId
Int32DeprecatedmonitorObjectId 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
deviceName
StringDeprecatedmonitorObjectDisplayName The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. N/A N/A
durationFormat
StringOptional The C#-format of duration columns where the value is a number. For example: F2 or N0. N/A F2
emptyTableText
StringOptional If present, and the table has no rows, the specified text will be inserted in place of the table. N/A N/A
endDate
DateTimeOffsetOptional The end date in the format YYYY-MM-DD. N/A Midnight on the first day of this month
errorCellColor
ColorOptional The error cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=240, G=128, B=0]
errorCellTextColor
ColorOptional The error cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
errorOnOverflow
BooleanOptional Should NCalc expression evaluation throw error on Overflow
  • true
  • false
true
failureText
StringOptional 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
fatalCellColor
ColorOptional The fatal cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=150, G=0, B=0]
fatalCellTextColor
ColorOptional The fatal cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
filterSDT
SdtFilterDeprecatedsdted 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
  • Sdt
  • NonSdt
All
fontSize
DoubleOptional Override the table style's font size. This is achieved by setting the font size for each table cell.
  • From 4 to 50
N/A
format
CellFormatOptional The cell format to use. Options are: 'AllStrings', 'Auto' or 'NumbersAsStrings'. Auto automatically sets the format for the whole column, or it can be forced to a string with AllStrings. To preserve date / time formatting (with dateTimeFormat) but treat only number columns as strings, use NumbersAsStrings.
  • Auto
  • AllStrings
  • NumbersAsStrings
Auto
group
StringDeprecatedresourceGroupName 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
hidden
BooleanOptional If true, the table will not be written to the report.
  • true
  • false
false
horizontalAlignment
TableHorizontalAlignmentOptional The horizontal alignment of the table on the page (does not affect Excel output).
  • Left
  • Center
  • Right
Left
host
StringDeprecatedmonitorObjectDisplayName The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. N/A N/A
id
StringOptional The specific unique alert ID to fetch. N/A N/A
if
StringOptional 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
includeCondition
StringOptional The condition on which each row is included. Fields should be referred to based on the column name in curly braces, for example: includeCondition ='{CreatedOn}'>'{StartOfLastMonth}'. N/A N/A
includeInactive
BooleanOptional true: Historical alert records will be returned (i.e. both active and inactive alert details). false: Only active alert details will be returned.
  • true
  • false
true
infoCellColor
ColorOptional The info cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=0, G=213, B=213]
infoCellTextColor
ColorOptional The info cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
internalId
StringDeprecatedproblemSignature Only include alerts matching this problem signature (InternalId). N/A N/A
maxAttempts
Int32Optional The maximum number of attempts when requesting data via the LogicMonitor API.
  • From 1 to 2147483647
N/A
minimumDurationMinutes
Int32Optional Filter alerts where the alert has been active for more than the specified number of minutes. N/A N/A
mode
MacroModeOptional The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.
  • Legacy
  • Normal
Legacy
monitorObjectDisplayName
String

Use instead of:

  • device
  • deviceName
  • host
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
monitorObjectId
Int32

Use instead of:

  • collectorId
  • deviceId
  • websiteId
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
MonitorObjectTypeOptional 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
  • Other
  • Website
Device
monthsToReport
Int32Optional If set, sets 'endDate' to the 'start' plus the specified number of months. N/A N/A
normalCellColor
ColorOptional The cell color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter. N/A
normalCellTextColor
ColorOptional The cell text color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter. N/A
obfuscation
ObfuscationTypeOptional 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
  • UkTown
  • DeviceName
  • Company
  • IpAddress
  • PrivateIpAddress
None
orderBy
StringOptional The order the alerts should be retrieved in. N/A StartOnSeconds
orderByDescending
StringOptional If present, sorts reverse alphanumerically by this column. N/A N/A
orderDirection
Filters.OrderDirectionOptional The direction of the order the alerts should be retrieved in.
  • Desc
  • Asc
Desc
pageWidthPercent
DoubleOptional The percentage of the available page that the table should occupy.
  • From 0 to 150
N/A
problemSignature
String

Use instead of:

  • internalId
Optional Only include alerts matching this problem signature (InternalId). N/A N/A
recurseDeviceGroups
BooleanOptional Whether to recurse device groups. Specify true to include alerts from child device groups.
  • true
  • false
true
repeatHeaderPerPage
BooleanOptional Whether to repeat the header row at the beginning of each page.
  • true
  • false
true
resourceGroupName
String

Use instead of:

  • deviceGroup
  • group
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
resourceTemplateDisplayName
StringOptional 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
resourceTemplateDisplayNameMatchesRegex
RegexOptional If present, only alerts with a resource template name matching the regular expression are included. N/A N/A
results
Int32Deprecatedtake The maximum number to take. N/A N/A
sdted
SdtFilter

Use instead of:

  • filterSDT
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
  • Sdt
  • NonSdt
All
serviceId
Int32Due to an issue with the LogicMonitor API, you should no longer filter alerts using any of the parameters: dataSourceName, dataSourceId, websiteName, websiteId. You have some choices, but the 'too long, didn't read' version is 'use a combination of resourceTemplateId and alertType parameters to filter by a specific LogicModule.' Here's the full spiel: 1) If you want to filter by a string, please filter using the resourceTemplateName and the *DisplayName* (not the unique name), but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this display name, you will have the desired outcome. 2) If you want to filter by an id, please filter using resourceTemplateId, but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this Id, you will have the desired outcome. You can use this in combination with the alertType parameter and a single alertType (e.g. DataSource) to guarantee the desired outcome.monitorObjectIdOptional DEPRECATED N/A N/A
serviceName
StringDue to an issue with the LogicMonitor API, you should no longer filter alerts using any of the parameters: dataSourceName, dataSourceId, websiteName, websiteId. You have some choices, but the 'too long, didn't read' version is 'use a combination of resourceTemplateId and alertType parameters to filter by a specific LogicModule.' Here's the full spiel: 1) If you want to filter by a string, please filter using the resourceTemplateName and the *DisplayName* (not the unique name), but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this display name, you will have the desired outcome. 2) If you want to filter by an id, please filter using resourceTemplateId, but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this Id, you will have the desired outcome. You can use this in combination with the alertType parameter and a single alertType (e.g. DataSource) to guarantee the desired outcome.resourceTemplateDisplayNameOptional DEPRECATED N/A N/A
skip
Int32Optional The number of items to skip. N/A N/A
startDate
DateTimeOffsetOptional The start date in the format YYYY-MM-DD. N/A Midnight on the first day of last month
style
StringOptional Use Word's built in Table Styles (such as Grid Table 2 - Accent 1), or make your own in the Report Template. Built-in styles can be used in any document. Note that any custom styles you create, or customisations to the standard styles required that the styles exist in the input template XML (because they are not saved in Word documents by default). This can be achieved by assigning the style to a table, then delete the table and save the document. N/A Table Grid
tableName
StringOptional The table name (e.g. for XLSX output) N/A Table
take
Int32

Use instead of:

  • results
Optional The maximum number to take. N/A N/A
thresholdAffects
ThresholdAffectsOptional What the threshold affects.
  • Cell
  • Row
Cell
thresholdColumn
StringOptional The threshold column. N/A N/A
useCache
BooleanOptional Whether to use the cache (where supported).
  • true
  • false
false
valueFormat
StringOptional The C#-format of the value column. For example: F2 or N0. N/A F2
waitDuringUpgrades
BooleanOptional Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).
  • true
  • false
N/A
warning
StringOptional 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
warningCellColor
ColorOptional The warning cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=240, G=192, B=0]
warningCellTextColor
ColorOptional The warning cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
websiteId
Int32DeprecatedmonitorObjectId 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
worksheetName
StringOptional The worksheet to save the result in the output Excel document (if so configured). Excel does not allow blank names, names above 31 characters, and the following characters: :, /, \, ?, *, [, ] N/A Table
writeToSpreadsheet
BooleanOptional Whether to output the result in the output Excel document (if so configured).
  • true
  • false
true
xlsxTableStyle
XlsxTableStyleOptional The XLSX table style to use in any XLSX output document.
  • TableStyleMedium13
  • None
  • TableStyleDark1
  • TableStyleDark10
  • TableStyleDark11
  • TableStyleDark2
  • TableStyleDark3
  • TableStyleDark4
  • TableStyleDark5
  • TableStyleDark6
  • TableStyleDark7
  • TableStyleDark8
  • TableStyleDark9
  • TableStyleLight1
  • TableStyleLight10
  • TableStyleLight11
  • TableStyleLight12
  • TableStyleLight13
  • TableStyleLight14
  • TableStyleLight15
  • TableStyleLight16
  • TableStyleLight17
  • TableStyleLight18
  • TableStyleLight19
  • TableStyleLight2
  • TableStyleLight20
  • TableStyleLight21
  • TableStyleLight3
  • TableStyleLight4
  • TableStyleLight5
  • TableStyleLight6
  • TableStyleLight7
  • TableStyleLight8
  • TableStyleLight9
  • TableStyleMedium1
  • TableStyleMedium10
  • TableStyleMedium11
  • TableStyleMedium12
  • TableStyleMedium14
  • TableStyleMedium15
  • TableStyleMedium16
  • TableStyleMedium17
  • TableStyleMedium18
  • TableStyleMedium19
  • TableStyleMedium2
  • TableStyleMedium20
  • TableStyleMedium21
  • TableStyleMedium22
  • TableStyleMedium23
  • TableStyleMedium24
  • TableStyleMedium25
  • TableStyleMedium26
  • TableStyleMedium27
  • TableStyleMedium28
  • TableStyleMedium3
  • TableStyleMedium4
  • TableStyleMedium5
  • TableStyleMedium6
  • TableStyleMedium7
  • TableStyleMedium8
  • TableStyleMedium9
TableStyleMedium13

Examples (2)

Example 1:
[LogicMonitor.AlertTable: dataPoint=PercentUsed, style=Grid Table 5 Dark - Accent 4, autoFit=Content, columns=Level;DeviceName;DataSourceInstance;StartOnLocal;AckComment, level=Warning]

Example 2: Normal mode

This Normal Mode example includes only alerts with acknowledgement comments starting with ABC:

[LogicMonitor.DeviceList: deviceGroups=/, recurseDeviceGroups=true, mode=Normal, orderBy=Status, =>DeviceDisplayNames][Json.List: jArray=`{=DeviceDisplayNames}`, jsonPath="$.[0].DisplayName", =>FirstDeviceDisplayName]
[LogicMonitor.AlertTable: monitorObjectDisplayName={FirstDeviceDisplayName}, columns=DataSourceInstance;StartOnLocal;AckComment, level=Warning, ackCommentMatchesRegex=ABC.*]
An unhandled error has occurred. Reload 🗙