The macro can be used in all input document types and in Report Studio.
Usage
Note that the 'format' parameter has no effect on the two date/time aggregations 'MinDateTime' and 'MaxDateTime', which are currently formatted in a fixed manner: dd-MM-yyyy hh:mm:ss (e.g. 18-04-2026 11:07:45). In Normal mode, the output variable is a JObject.
Recent Updates
[ 2026-07-08 ]
The PercentUpTime aggregation now supports the 'WinSystemUptime' LogicMonitor DataSource and the 'UptimeSeconds' datapoint.
Parameters(166)
Mandatory(2)
Parameter
Type
Purpose
Options
Default
aggregations
List<String>
Various macros can use aggregations to summarise the data, such as counting a list of values, averaging them, and so on. This can be useful in your reports as it enables you to easily obtain daily, weekly, or monthly values to use in your charts and tables. For more information about using aggregations, see: using aggregations in the help. NOTE: when using PercentUpTime, the dataSourceInstanceName must be set to 'SNMP_Host_Uptime', and the dataPoint set to 'Uptime', OR 'WinSystemUptime' and 'UptimeSeconds', or the macro will fail. In the latter case, you should also set 'graphId' to -1.
All
Count
CountConditionMet
Delta
DeltaPercent
First
Last
Max
MaxDateTime
Mean
Min
MinDateTime
PercentConditionMet
Percentile
PercentUpTime
PercentUpTimeAdvanced
Sum
N/A
dataPoint
String
The LogicMonitor graph DataPoint (the name of the datapoint on the graph legend).
N/A
N/A
Behaviour(1)13 additional
Parameter
Type
Presence
Purpose
Options
Default
fatalIf
String
Optional
The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression.
N/A
N/A
Additional (13)
Parameter
Type
Presence
Purpose
Options
Default
auto
Boolean
Optional
If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used.
true
false
false
calculate
String
Optional
Post processing formula. Use {value} for the macro output, e.g. {value}/1024.
N/A
N/A
errorOnOverflow
Boolean
Optional
Should NCalc expression evaluation throw error on Overflow
true
false
true
hidden
Boolean
Optional
Whether to hide the macro output.
true
false
false
if
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
maxAttempts
Int32
Optional
The maximum number of attempts when requesting data via the LogicMonitor API.
From 1 to 2147483647
N/A
mode
MacroMode
Optional
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 theObject, e.g. an Int32 or a List etc., rather than a formatted string.
Legacy
Normal
Legacy
obfuscation
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
UkTown
DeviceName
Company
IpAddress
PrivateIpAddress
None
recurseDeviceGroups
Boolean
Optional
Whether to recurse Device Groups. Specify false to exclude child Device Groups.
true
false
true
redact
Boolean
Optional
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
useCache
Boolean
Optional
Whether to use the cache (where supported).
true
false
false
waitDuringUpgrades
Boolean
Optional
Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).
true
false
N/A
warning
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
Colours(3)3 additional
Parameter
Type
Presence
Purpose
Options
Default
normalFontBackgroundColor
Color
Optional
The normal font background color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
normalFontColor
Color
Optional
The normal font color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
normalTableCellBackgroundColor
Color
Optional
The normal table cell background color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
Additional (3)
Parameter
Type
Presence
Purpose
Options
Default
colorTableCell
Boolean
Optional
Whether to color table cells if thresholds are breached, rather than color the text.
true
false
true
fontBackgroundColor
Color
Optional
The font background color to use.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
fontColor
Color
Optional
The font color to use.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
Formatting(2)5 additional
Parameter
Type
Presence
Purpose
Options
Default
normalFontBold
Boolean
Optional
Change the normal font weight (true=strong, false=normal). If omitted, no change is made.
true
false
N/A
normalFontSize
Double
Optional
Change the normal font size in points. If omitted, no change is made.
From 2 to 200
N/A
Additional (5)
Parameter
Type
Presence
Purpose
Options
Default
flowDirection
FlowDirection
Optional
The traffic flow direction. Used only with type=NetflowBandwidth (or type=NetflowBandwidth, which is exactly the same).
All
In
Out
All
fontBold
Boolean
Optional
Change the font weight (true=strong, false=normal). If omitted, no change is made.
true
false
N/A
fontSize
Double
Optional
Change the font size in points. If omitted, no change is made.
From 2 to 200
N/A
format
String
Optional
The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings.
N/A
N/A
titleHeadingLevel
Int32
Optional
If auto-titling the graph, the heading level to use.
From 1 to 6
N/A
Conditional Formatting(69)
Parameter
Type
Presence
Purpose
Options
Default
criticalAfter
DateTimeOffset
Optional
The macro is considered 'critical' if the output is after this DateTime UTC.
N/A
N/A
criticalBefore
DateTimeOffset
Optional
The macro is considered 'critical' if the output is before this DateTime UTC.
N/A
N/A
criticalEq
String
Optional
The macro is considered 'critical' if the output is equal to this value.
N/A
N/A
criticalFontBackgroundColor
Color
Optional
The critical font background color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
criticalFontBold
Boolean
Optional
Change the font weight (true=strong, false=normal). If omitted, no change is made.
true
false
N/A
criticalFontColor
Color
Optional
The critical font color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
criticalFontSize
Double
Optional
Change the critical font size in points. If omitted, no change is made.
From 2 to 200
N/A
criticalGe
String
Optional
The macro is considered 'critical' if the output is greater than or equal to this value.
N/A
N/A
criticalGt
String
Optional
The macro is considered 'critical' if the output is greater than this value.
N/A
N/A
criticalIf
String
Optional
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
String
Optional
The macro is considered 'critical' if the output is less than or equal to this value.
N/A
N/A
criticalLt
String
Optional
The macro is considered 'critical' if the output is less than this value.
N/A
N/A
criticalNe
String
Optional
The macro is considered 'critical' if the output is not equal to this value.
N/A
N/A
criticalTableCellBackgroundColor
Color
Optional
The critical table cell background color to use.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
errorAfter
DateTimeOffset
Optional
The macro is considered 'error' if the output is after this DateTime UTC.
N/A
N/A
errorBefore
DateTimeOffset
Optional
The macro is considered 'error' if the output is before this DateTime UTC.
N/A
N/A
errorEq
String
Optional
The macro is considered 'error' if the output is equal to this value.
N/A
N/A
errorFontBackgroundColor
Color
Optional
The error font background color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
errorFontBold
Boolean
Optional
Change the error font weight (true=strong, false=normal). If omitted, no change is made.
true
false
N/A
errorFontColor
Color
Optional
The error font color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
errorFontSize
Double
Optional
Change the error font size in points. If omitted, no change is made.
From 2 to 200
N/A
errorGe
String
Optional
The macro is considered 'error' if the output is greater than or equal to this value.
N/A
N/A
errorGt
String
Optional
The macro is considered 'error' if the output is greater than this value.
N/A
N/A
errorIf
String
Optional
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
String
Optional
The macro is considered 'error' if the output is less than or equal to this value.
N/A
N/A
errorLt
String
Optional
The macro is considered 'error' if the output is less than this value.
N/A
N/A
errorNe
String
Optional
The macro is considered 'error' if the output is not equal to this value.
N/A
N/A
errorTableCellBackgroundColor
Color
Optional
The error table cell background color to use.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
fatalAfter
DateTimeOffset
Optional
The macro is considered 'fatal' if the output is after this DateTime UTC.
N/A
N/A
fatalBefore
DateTimeOffset
Optional
The macro is considered 'fatal' if the output is before this DateTime UTC.
N/A
N/A
fatalEq
String
Optional
The macro is considered 'fatal' if the output is equal to this value.
N/A
N/A
fatalFontBackgroundColor
Color
Optional
The fatal font background color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
fatalFontBold
Boolean
Optional
Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.
true
false
N/A
fatalFontColor
Color
Optional
The fatal font color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
fatalFontSize
Double
Optional
Change the fatal font size in points. If omitted, no change is made.
From 2 to 200
N/A
fatalGe
String
Optional
The macro is considered 'fatal' if the output is greater than or equal to this value.
N/A
N/A
fatalGt
String
Optional
The macro is considered 'fatal' if the output is greater than this value.
N/A
N/A
fatalLe
String
Optional
The macro is considered 'fatal' if the output is less than or equal to this value.
N/A
N/A
fatalLt
String
Optional
The macro is considered 'fatal' if the output is less than this value.
N/A
N/A
fatalNe
String
Optional
The macro is considered 'fatal' if the output is not equal to this value.
N/A
N/A
fatalTableCellBackgroundColor
Color
Optional
The fatal table cell background color to use.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
infoAfter
DateTimeOffset
Optional
The macro is considered 'info' if the output is after this DateTime UTC.
N/A
N/A
infoBefore
DateTimeOffset
Optional
The macro is considered 'info' if the output is before this DateTime UTC.
N/A
N/A
infoEq
String
Optional
The macro is considered 'info' if the output is equal to this value.
N/A
N/A
infoFontBackgroundColor
Color
Optional
The info font background color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
infoFontBold
Boolean
Optional
Change the info font weight (true=strong, false=normal). If omitted, no change is made.
true
false
N/A
infoFontColor
Color
Optional
The info font color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
infoFontSize
Double
Optional
Change the info font size in points. If omitted, no change is made.
From 2 to 200
N/A
infoGe
String
Optional
The macro is considered 'info' if the output is greater than or equal to this value.
N/A
N/A
infoGt
String
Optional
The macro is considered 'info' if the output is greater than this value.
N/A
N/A
infoIf
String
Optional
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
String
Optional
The macro is considered 'info' if the output is less than or equal to this value.
N/A
N/A
infoLt
String
Optional
The macro is considered 'info' if the output is less than this value.
N/A
N/A
infoNe
String
Optional
The macro is considered 'info' if the output is not equal to this value.
N/A
N/A
infoTableCellBackgroundColor
Color
Optional
The info table cell background color to use.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
warningAfter
DateTimeOffset
Optional
The macro is considered 'warning' if the output is after this DateTime UTC.
N/A
N/A
warningBefore
DateTimeOffset
Optional
The macro is considered 'warning' if the output is before this DateTime UTC.
N/A
N/A
warningEq
String
Optional
The macro is considered 'warning' if the output is equal to this value.
N/A
N/A
warningFontBackgroundColor
Color
Optional
The warning font background color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
warningFontBold
Boolean
Optional
Change the warning font weight (true=strong, false=normal). If omitted, no change is made.
true
false
N/A
warningFontColor
Color
Optional
The warning font color to use. If omitted, no change is made.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
warningFontSize
Double
Optional
Change the warning font size in points. If omitted, no change is made.
From 2 to 200
N/A
warningGe
String
Optional
The macro is considered 'warning' if the output is greater than or equal to this value.
N/A
N/A
warningGt
String
Optional
The macro is considered 'warning' if the output is greater than this value.
N/A
N/A
warningIf
String
Optional
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
String
Optional
The macro is considered 'warning' if the output is less than or equal to this value.
N/A
N/A
warningLt
String
Optional
The macro is considered 'warning' if the output is less than this value.
N/A
N/A
warningNe
String
Optional
The macro is considered 'warning' if the output is not equal to this value.
N/A
N/A
warningTableCellBackgroundColor
Color
Optional
The warning table cell background color to use.
A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.
N/A
Chart(5)
Parameter
Type
Presence
Purpose
Options
Default
graphId
Int32
Conditional
The graph ID. If set, do not set the 'graphName' parameter. You can use -1 to use raw data when there is no graph in LogicMonitor but you must choose the data point name as it appears on the 'Raw Data' tab in LogicMonitor, rather than the name in the DataPoint definition.
N/A
N/A
graphName
String
Conditional
The graph name. If set, do not set the 'graphId' parameter.
N/A
N/A
interLineAggregation
InterLineGraphDataAggregation
Conditional
The aggregation to use for inter-line aggregation only if 'aggregateOverDevices' or 'aggregateOverDataSourceInstances' are set to true.
All
Count
First
Last
Max
Mean
Min
Sum
All
overviewGraphId
Int32
Conditional
The overview graph ID.
N/A
N/A
overviewGraphName
String
Conditional
The overview graph name.
N/A
N/A
Time & Date(6)
Parameter
Type
Presence
Purpose
Options
Default
endDate
DateTimeOffset
Optional
The end date in the format YYYY-MM-DD.
N/A
Midnight on the first day of this month
forecast
Boolean
Optional
Whether to include forecast data.
true
false
false
forecastTime
String
Optional
The time to forecast.
7days
14days
1month
3months
7days
forecastTrainingTime
String
Optional
The amount of data to use to inform the forecast.
1month
1year
3months
6months
1month
monthsToReport
Int32
Optional
If set, sets 'endDate' to the 'start' plus the specified number of months.
N/A
N/A
startDate
DateTimeOffset
Optional
The start date in the format YYYY-MM-DD.
N/A
Midnight on the first day of last month
Filtering & Sorting(1)2 additional
Parameter
Type
Presence
Purpose
Options
Default
excludeSdt
Boolean
Optional
Whether to exclude periods of SDT from the macro results. Works for Devices and Websites only. Note that an SDT set on a Device Group (or Website Group) will be counted towards the relevant Device / Website.
true
false
false
Additional (2)
Parameter
Type
Presence
Purpose
Options
Default
excludeDataPoint
List<String>
Optional
The datapoints to exclude.
N/A
N/A
includeDataPoint
List<String>
Optional
The datapoints to include.
N/A
N/A
Output(2)8 additional
Parameter
Type
Presence
Purpose
Options
Default
delimiter
Char
Optional
The output value delimiter to use if multiple aggregations are requested.
N/A
;
outputDateTimes
Boolean
Optional
Relevant only for the PercentConditionMet aggregation. In Legacy mode, this outputs the date time ranges that the condition, rather than the aggregation values, and in Normal mode these are added onto the 'Aggregations' object as a jArray (of strings) in the 'PercentConditionMetDateRanges' property. Works for Devices and Websites. When used for Devices and a multi-instance data source is specified (AND dataSourceInstanceName is not set AND dataSourceInstanceId is not set), a macro error will occur, as it is not permitted to specify this combination as an inherently 'meaningless' output will result.
true
false
false
Additional (8)
Parameter
Type
Presence
Purpose
Options
Default
failureText
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
failureVariable
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
outputListsAsJarray
Normal mode
Boolean
Optional
Any macros that output lists can optionally (in Normal mode) output a jArray instead.
true
false
true
storeAs
String
Optional
The variable to store the result as.
N/A
N/A
storeAsHidden
String
Optional
The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.
N/A
N/A
storeAsVariableDelimiter
Char
Optional
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
String
Optional
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
writeToSpreadsheet
Boolean
Optional
Whether to write output to a spreadsheet.
true
false
N/A
General(3)24 additional
Parameter
Type
Presence
Purpose
Options
Default
aggregations
List<String>
Mandatory
Various macros can use aggregations to summarise the data, such as counting a list of values, averaging them, and so on. This can be useful in your reports as it enables you to easily obtain daily, weekly, or monthly values to use in your charts and tables. For more information about using aggregations, see: using aggregations in the help. NOTE: when using PercentUpTime, the dataSourceInstanceName must be set to 'SNMP_Host_Uptime', and the dataPoint set to 'Uptime', OR 'WinSystemUptime' and 'UptimeSeconds', or the macro will fail. In the latter case, you should also set 'graphId' to -1.
All
Count
CountConditionMet
Delta
DeltaPercent
First
Last
Max
MaxDateTime
Mean
Min
MinDateTime
PercentConditionMet
Percentile
PercentUpTime
PercentUpTimeAdvanced
Sum
N/A
dataPoint
String
Mandatory
The LogicMonitor graph DataPoint (the name of the datapoint on the graph legend).
N/A
N/A
precision
PrecisionType
Optional
The data precision. Use 'High' to fetch data in 8-hour chunks, which fetches many more data points. Note: this option may be very slow, so use with caution.
Normal
High
Normal
Additional (24)
Parameter
Type
Presence
Purpose
Options
Default
dataSourceInstanceGroupId
Int32
Conditional
The DataSource instance group id. If set, the dataSource parameter must also be set.
N/A
N/A
dataSourceInstanceGroupName
String
Conditional
The DataSource instance group name. If set, the dataSource parameter must also be set.
N/A
N/A
dataSourceInstanceId
Int32
Conditional
The DataSource instance ID. If set, the dataSource parameter must also be set.
N/A
N/A
dataSourceInstanceName
String
Conditional
The DataSource instance name. If set, the dataSource parameter must also be set.
N/A
N/A
dataSourceName
String
Conditional
The DataSource name.
N/A
N/A
websiteCheckPointName
List<String>
Conditional
The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint).
N/A
N/A
websiteName
List<String>
Conditional
The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint).
N/A
N/A
widgetId
Int32
Conditional
The Widget ID for dashboard graphs. The type / graphType parameter should be set to DashboardWidget. Finding the Widget id requires a few steps: you will need to use your LogicMonitor portal UI, enter developer mode in the browser, and find all 'li' elements (which are the Widgets) where the 'data_component_unique_name' attribute is like xxx_widget_xxx, where xxx are numbers. For example, 99_widget_123 is a Widget ID of 123.
N/A
N/A
aggregateOverDataSourceInstances
Boolean
Optional
Whether to aggregate over DataSource instances. If specified, the 'interLineAggregation' parameter must also be specified.
true
false
false
aggregateOverDevices
Boolean
Optional
Whether to aggregate over Devices. If specified, the 'interLineAggregation' parameter must also be specified.
true
false
false
autoTitle
Boolean
Optional
Whether to auto title the graph.
true
false
true
comment
String
Optional
Add a comment to make your document template more readable. The comment is discarded in the output document.
N/A
N/A
connectionName
String
Optional
The name of the Connection.
N/A
N/A
dataSourceId
Int32
Optional
The DataSource ID.
N/A
N/A
desiredExecutionResult
ExecutionResult
Optional
If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, 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, Stopped.
Cancelled
Deferred
MacroError
NeverRun
Paused
Pending
Running
Stopped
Success
SystemError
Warning
WorkerStopped
N/A
deviceGroups
List<String>
Optional
The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.
N/A
N/A
deviceIds
List<Int32>
Optional
The Device ID or IDs.
N/A
N/A
devices
List<String>
Optional
The Device Display name or names.
N/A
N/A
expectedType
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
expectedValue
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
flowInterfaceIndices
List<String>
Optional
The traffic flow interfaces e.g. 1;2;3 for interfaces 1, 2 and 3. Used only with type=NetflowBandwidth.
N/A
N/A
singleValueList
Normal mode
Boolean
Optional
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
type
GraphType
Optional
The graph type. Note that the default is Device, so you should change this if, for example, you are requesting graphs from Websites or other types.
Device
WebsiteOverview
NetflowBandwidth
WebsiteCheckPoint
DashboardWidget
Device
websiteIds
List<Int32>
Optional
The Website ID or IDs.
N/A
N/A
Deprecated(1)18 additional
Parameter
Type
Preferred Parameter
Purpose
Options
Default
aggregation
List<String>
aggregations
Various macros can use aggregations to summarise the data, such as counting a list of values, averaging them, and so on. This can be useful in your reports as it enables you to easily obtain daily, weekly, or monthly values to use in your charts and tables. For more information about using aggregations, see: using aggregations in the help. NOTE: when using PercentUpTime, the dataSourceInstanceName must be set to 'SNMP_Host_Uptime', and the dataPoint set to 'Uptime', OR 'WinSystemUptime' and 'UptimeSeconds', or the macro will fail. In the latter case, you should also set 'graphId' to -1.
All
Count
CountConditionMet
Delta
DeltaPercent
First
Last
Max
MaxDateTime
Mean
Min
MinDateTime
PercentConditionMet
Percentile
PercentUpTime
PercentUpTimeAdvanced
Sum
N/A
Additional (18)
Parameter
Type
Preferred Parameter
Purpose
Options
Default
dataSource
String
dataSourceName
The DataSource name.
N/A
N/A
serviceCheckPointName
List<String>
websiteCheckPointName
The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint).
N/A
N/A
serviceCheckPointNames
List<String>
websiteCheckPointName
The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint).
N/A
N/A
serviceName
List<String>
websiteName
The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint).
N/A
N/A
serviceNames
List<String>
websiteName
The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint).
N/A
N/A
websiteCheckPointNames
List<String>
websiteCheckPointName
The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint).
N/A
N/A
websiteNames
List<String>
websiteName
The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint).
N/A
N/A
autoTitleHeadingLevel
Int32
titleHeadingLevel
If auto-titling the graph, the heading level to use.
From 1 to 6
N/A
device
List<String>
devices
The Device Display name or names.
N/A
N/A
deviceGroup
List<String>
deviceGroups
The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.
N/A
N/A
deviceId
List<Int32>
deviceIds
The Device ID or IDs.
N/A
N/A
graphType
GraphType
type
The graph type. Note that the default is Device, so you should change this if, for example, you are requesting graphs from Websites or other types.
Device
WebsiteOverview
NetflowBandwidth
WebsiteCheckPoint
DashboardWidget
Device
group
List<String>
deviceGroups
The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.
N/A
N/A
groups
List<String>
deviceGroups
The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.
Similar to the previous example, but in this case obtain a list of time ranges (instead of the percentage value) where the PercentConditionMet condition succeeded, by setting the 'outputDateTimes' parameter:
Similar to the previous examples, but in this case (in Normal mode) store the 2 PercentConditionMet values to properties called 'PercentConditionMet5' and 'PercentConditionMet15'. This is useful to avoid 'duplicate property names' in the output, which is not allowed in Normal mode (JObject/JArray output).
[LogicMonitor.SummaryValue: device=pdl-dr-prod-01, graphName=CPU, dataSourceInstanceName=NetSNMPCPU, dataPoint=UserPercent, aggregations=PercentConditionMet(value>5) as PercentConditionMet5;PercentConditionMet(value>15) as PercentConditionMet15, aggregateOverDevices=true, mode=Normal]
[LogicMonitor.SummaryValue: device=pdl-dr-prod-01, graphName=CPU, dataSourceInstanceName=NetSNMPCPU, dataPoint=UserPercent, aggregations=Percentile(25) as Percentile25;Percentile(50) as Percentile50;Percentile(75) as Percentile75, aggregateOverDevices=true]
Example 8
[LogicMonitor.WebsiteList: websiteGroup=/, recurseWebsiteGroups=true, mode=Legacy, storeAs=myWebsitesIds, properties=Id]
[ForEach: storeAs=websiteid, values={myWebsitesIds}]
*** [String:value={websiteid}***]
[LogicMonitor.SummaryValue: websiteIds={websiteid}, graphName=OverallStatus, dataPoint="Status 1=ok, 2=error", graphType=WebsiteOverview, aggregations=Min;Mean;Max;Percentile(0);Percentile(50) as percentile50;Percentile(75) as percentile75;Percentile(100) as percentile100, outputDateTimes=true, mode=Normal]
[EndForEach:]
Example 9Normal mode
This Normal Mode example shows how to calculate the percentage uptime for all Devices that have the 'WinSystemUptime' data source, using its 'UptimeSeconds' datapoint:
[LogicMonitor.DeviceList: deviceGroups="/", recurseDeviceGroups=true, mode=Normal, property=Id, singleValueList=true, =>DeviceIds]
[ForEach: values={=DeviceIds}, storeAs=DeviceId]
[LogicMonitor.DeviceDataSourceList: singleValueList=true, deviceId={=DeviceId}, properties=DataSourceName, mode=Normal, =>DataSources]
[List.Count: values={=DataSources}, condition=`value == 'WinSystemUptime'`, =>Count][If: condition=`Count == 1`]
Device with ID # [String: value={DeviceId}] has an uptime of [LogicMonitor.SummaryValue: deviceId={DeviceId}, dataSourceInstanceName=WinSystemUptime, graphId=-1, dataPoint=UptimeSeconds, aggregation=PercentUpTime, startDate=2025-06-01, endDate=2025-07-01, excludeSdt=true, format=F4, =>Value][.:Value.PercentUpTime]%
[EndIf:][EndForEach:]
Example 10Normal mode
This Normal Mode example shows how to calculate the percentage uptime for all Devices that have the 'SNMP_Host_Uptime' data source, using its 'Uptime' datapoint:
[LogicMonitor.DeviceList: deviceGroups="/", recurseDeviceGroups=true, mode=Normal, property=Id, singleValueList=true, =>DeviceIds]
[ForEach: values={=DeviceIds}, storeAs=DeviceId]
[LogicMonitor.DeviceDataSourceList: singleValueList=true, deviceId={=DeviceId}, properties=DataSourceName, mode=Normal, =>DataSources]
[List.Count: values={=DataSources}, condition=`value == 'SNMP_Host_Uptime'`, =>Count][If: condition=`Count == 1`]
Device with ID # [String: value={DeviceId}] has an uptime of [LogicMonitor.SummaryValue: deviceId={DeviceId}, dataSourceInstanceName=SNMP_Host_Uptime, graphId=-1, dataPoint=Uptime, aggregation=PercentUpTime, startDate=2025-06-01, endDate=2025-07-01, excludeSdt=true, format=F4, =>Value][.:Value.PercentUpTime]%
[EndIf:][EndForEach:]
