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.AlertCount:]

Inserts an alert count based on alert filter criteria.


Purpose

Counts the number of alerts that were active in the reporting period, matching the filter supplied.


Macro Compatibility

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


Usage

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


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
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
calculate
StringOptional Post processing formula. Use {value} for the macro output, e.g. {value}/1024. N/A N/A
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
colorTableCell
BooleanOptional Whether to color table cells if thresholds are breached, rather than color the text.
  • true
  • false
true
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 LogicMonitor Connection. N/A N/A
criticalAfter
DateTimeOffsetOptional The macro is considered 'critical' if the output is after this DateTime UTC. N/A N/A
criticalBefore
DateTimeOffsetOptional The macro is considered 'critical' if the output is before this DateTime UTC. N/A N/A
criticalEq
StringOptional The macro is considered 'critical' if the output is equal to this value. N/A N/A
criticalFontBackgroundColor
ColorOptional The critical font background color to use. If omitted, no change is made. N/A
criticalFontBold
BooleanOptional Change the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
criticalFontColor
ColorOptional The critical font color to use. If omitted, no change is made. N/A
criticalFontSize
DoubleOptional Change the critical font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
criticalGe
StringOptional The macro is considered 'critical' if the output is greater than or equal to this value. N/A N/A
criticalGt
StringOptional The macro is considered 'critical' if the output is greater than this value. N/A N/A
criticalIf
StringOptional The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
criticalLe
StringOptional The macro is considered 'critical' if the output is less than or equal to this value. N/A N/A
criticalLt
StringOptional The macro is considered 'critical' if the output is less than this value. N/A N/A
criticalNe
StringOptional The macro is considered 'critical' if the output is not equal to this value. N/A N/A
criticalTableCellBackgroundColor
ColorOptional The critical table cell background color to use. 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
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
endDate
DateTimeOffsetOptional The end date in the format YYYY-MM-DD. N/A Midnight on the first day of this month
errorAfter
DateTimeOffsetOptional The macro is considered 'error' if the output is after this DateTime UTC. N/A N/A
errorBefore
DateTimeOffsetOptional The macro is considered 'error' if the output is before this DateTime UTC. N/A N/A
errorEq
StringOptional The macro is considered 'error' if the output is equal to this value. N/A N/A
errorFontBackgroundColor
ColorOptional The error font background color to use. If omitted, no change is made. N/A
errorFontBold
BooleanOptional Change the error font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
errorFontColor
ColorOptional The error font color to use. If omitted, no change is made. N/A
errorFontSize
DoubleOptional Change the error font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
errorGe
StringOptional The macro is considered 'error' if the output is greater than or equal to this value. N/A N/A
errorGt
StringOptional The macro is considered 'error' if the output is greater than this value. N/A N/A
errorIf
StringOptional The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
errorLe
StringOptional The macro is considered 'error' if the output is less than or equal to this value. N/A N/A
errorLt
StringOptional The macro is considered 'error' if the output is less than this value. N/A N/A
errorNe
StringOptional The macro is considered 'error' if the output is not equal to this value. N/A N/A
errorOnOverflow
BooleanOptional Should NCalc expression evaluation throw error on Overflow
  • true
  • false
true
errorTableCellBackgroundColor
ColorOptional The error table cell background color to use. N/A
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
fatalAfter
DateTimeOffsetOptional The macro is considered 'fatal' if the output is after this DateTime UTC. N/A N/A
fatalBefore
DateTimeOffsetOptional The macro is considered 'fatal' if the output is before this DateTime UTC. N/A N/A
fatalEq
StringOptional The macro is considered 'fatal' if the output is equal to this value. N/A N/A
fatalFontBackgroundColor
ColorOptional The fatal font background color to use. If omitted, no change is made. N/A
fatalFontBold
BooleanOptional Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fatalFontColor
ColorOptional The fatal font color to use. If omitted, no change is made. N/A
fatalFontSize
DoubleOptional Change the fatal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
fatalGe
StringOptional The macro is considered 'fatal' if the output is greater than or equal to this value. N/A N/A
fatalGt
StringOptional The macro is considered 'fatal' if the output is greater than this value. N/A N/A
fatalIf
StringOptional The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
fatalLe
StringOptional The macro is considered 'fatal' if the output is less than or equal to this value. N/A N/A
fatalLt
StringOptional The macro is considered 'fatal' if the output is less than this value. N/A N/A
fatalNe
StringOptional The macro is considered 'fatal' if the output is not equal to this value. N/A N/A
fatalTableCellBackgroundColor
ColorOptional The fatal table cell background color to use. 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
fontBackgroundColor
ColorOptional The font background color to use. N/A
fontBold
BooleanOptional Change the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fontColor
ColorOptional The font color to use. N/A
fontSize
DoubleOptional Change the font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
format
StringOptional The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings. N/A N/A
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 Whether to hide the macro output.
  • true
  • false
false
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
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
infoAfter
DateTimeOffsetOptional The macro is considered 'info' if the output is after this DateTime UTC. N/A N/A
infoBefore
DateTimeOffsetOptional The macro is considered 'info' if the output is before this DateTime UTC. N/A N/A
infoEq
StringOptional The macro is considered 'info' if the output is equal to this value. N/A N/A
infoFontBackgroundColor
ColorOptional The info font background color to use. If omitted, no change is made. N/A
infoFontBold
BooleanOptional Change the info font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
infoFontColor
ColorOptional The info font color to use. If omitted, no change is made. N/A
infoFontSize
DoubleOptional Change the info font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
infoGe
StringOptional The macro is considered 'info' if the output is greater than or equal to this value. N/A N/A
infoGt
StringOptional The macro is considered 'info' if the output is greater than this value. N/A N/A
infoIf
StringOptional The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
infoLe
StringOptional The macro is considered 'info' if the output is less than or equal to this value. N/A N/A
infoLt
StringOptional The macro is considered 'info' if the output is less than this value. N/A N/A
infoNe
StringOptional The macro is considered 'info' if the output is not equal to this value. N/A N/A
infoTableCellBackgroundColor
ColorOptional The info table cell background color to use. 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
normalFontBackgroundColor
ColorOptional The normal font background color to use. If omitted, no change is made. N/A
normalFontBold
BooleanOptional Change the normal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
normalFontColor
ColorOptional The normal font color to use. If omitted, no change is made. N/A
normalFontSize
DoubleOptional Change the normal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
normalTableCellBackgroundColor
ColorOptional The normal table cell background color to use. If omitted, no change is made. 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
orderDirection
Filters.OrderDirectionOptional The direction of the order the alerts should be retrieved in.
  • Desc
  • Asc
Desc
outputListsAsJarray
Normal mode
BooleanOptional Any macros that output lists can optionally (in Normal mode) output a jArray instead.
  • true
  • false
true
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
redact
BooleanOptional Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).
  • true
  • false
false
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
singleValueList
Normal mode
BooleanOptional In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.
  • true
  • false
false
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
storeAs
StringOptional The variable to store the result as. N/A N/A
storeAsHidden
StringOptional The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. N/A N/A
storeAsVariableDelimiter
CharOptional The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*] N/A ;
storeFormattedValueAs
StringOptional The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that. N/A N/A
take
Int32

Use instead of:

  • results
Optional The maximum number to take. N/A N/A
useCache
BooleanOptional Whether to use the cache (where supported).
  • true
  • false
false
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
warningAfter
DateTimeOffsetOptional The macro is considered 'warning' if the output is after this DateTime UTC. N/A N/A
warningBefore
DateTimeOffsetOptional The macro is considered 'warning' if the output is before this DateTime UTC. N/A N/A
warningEq
StringOptional The macro is considered 'warning' if the output is equal to this value. N/A N/A
warningFontBackgroundColor
ColorOptional The warning font background color to use. If omitted, no change is made. N/A
warningFontBold
BooleanOptional Change the warning font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
warningFontColor
ColorOptional The warning font color to use. If omitted, no change is made. N/A
warningFontSize
DoubleOptional Change the warning font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
warningGe
StringOptional The macro is considered 'warning' if the output is greater than or equal to this value. N/A N/A
warningGt
StringOptional The macro is considered 'warning' if the output is greater than this value. N/A N/A
warningIf
StringOptional The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
warningLe
StringOptional The macro is considered 'warning' if the output is less than or equal to this value. N/A N/A
warningLt
StringOptional The macro is considered 'warning' if the output is less than this value. N/A N/A
warningNe
StringOptional The macro is considered 'warning' if the output is not equal to this value. N/A N/A
warningTableCellBackgroundColor
ColorOptional The warning table cell background color to use. 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

Examples (2)

Example 1: Normal mode

This example finds the first Device in the LogicMonitor portal, then outputs the number of alerts:

[LogicMonitor.DeviceList: deviceGroups=/, recurseDeviceGroups=true, orderBy=Status, mode=Normal, =>DeviceGroupsA]
Device [Json.List: jArray=`{=DeviceGroupsA}`, jsonPath="$.[0].DisplayName", storeAs=Device] has [LogicMonitor.AlertCount: device={Device}] alerts.

Example 2: Normal mode

This example finds the first Device in the LogicMonitor portal, then outputs the number of active alerts:

[LogicMonitor.DeviceList: deviceGroups=/, recurseDeviceGroups=true, orderBy=Status, mode=Normal, =>DeviceGroupsB]
Device [Json.List: jArray=`{=DeviceGroupsB}`, jsonPath="$.[0].DisplayName", storeAs=Device] has [LogicMonitor.AlertCount: device={Device}, includeInactive=false] active alerts.
An unhandled error has occurred. Reload 🗙