Presents one or more aggregations of graph data.
Compatibility
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. 19-11-2026 04:12:12). In Normal mode, the output variable is a JObject.
Updates
With 'interLineAggregation' set to Sum, a time at which none of the lines has a value is now left out, as it already was for a single line, instead of counting as 0. Such a time no longer lowers Min and Mean or adds to Count, and Last has no value when none of the lines has a value at the last time. A report that calculates with these figures should allow for one having no value.
History (1)
The MinDateTime and MaxDateTime aggregations now report the correct date/time when using high precision.
Mandatory (2)
| Parameter | Type | Purpose | Options | Default |
| 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. |
|
N/A | |
| String | The LogicMonitor graph DataPoint (the name of the datapoint on the graph legend). | N/A | N/A |
Behaviour (16)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used. |
|
false | |
| String | Optional | Post processing formula. Use {value} to substitute the macro's output into the formula as text, e.g. {value}/1024, or the bare word value to use the output itself, e.g. jPath(value, 'id') to read a property from an object. If the result is fractional it is shown to two decimal places unless you also set format, e.g. format=G to show it in full; a value kept by storeAs always retains its full precision. | N/A | N/A | |
| List<ExecutionResult> | Optional | If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: 'Unknown', 'Success', 'MacroError', 'WorkerStopped', 'Running', 'Warning', 'NeverRun', 'Cancelled', 'Pending', 'Paused', 'SystemError', 'Deferred' and 'Stopped'. |
|
N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| String | Optional | If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type. | N/A | N/A | |
| String | Optional | If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared. | N/A | N/A | |
| Boolean | Optional | Whether to hide the macro output. |
|
false | |
| 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 | |
| Int32 | Optional | The maximum number of attempts when requesting data via the LogicMonitor API. |
|
N/A | |
| MacroMode | Optional | The mode in which variables are stored. In legacy mode (default for Schedules), the variable created is a string and formatted. In normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a JArray etc., rather than a formatted string. |
|
Legacy | |
| ObfuscationType | Optional | Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen. |
|
None | |
| Boolean | Optional | Whether to recurse Device Groups. Specify false to exclude child Device Groups. |
|
true | |
| 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). |
|
false | |
| Boolean | Optional | Whether to use the cache (where supported). |
|
false | |
| Boolean | Optional | Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses). |
|
N/A | |
| 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 (18)3 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Color | Optional | The critical font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The critical font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The critical table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The error font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The error font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The error table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The fatal font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The fatal font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The fatal table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The info font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The info font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The info table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The warning font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The warning font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The warning table cell background color to use. If omitted, no change is made. |
|
N/A |
Additional (3)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Whether to color table cells if thresholds are breached, rather than color the text. |
|
true | |
| Color | Optional | The font background color to use. |
|
N/A | |
| Color | Optional | The font color to use. |
|
N/A |
Formatting (12)5 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Change the critical font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the critical font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the error font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the error font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the fatal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the fatal font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the info font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the info font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the normal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the normal font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the warning font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the warning font size in points. If omitted, no change is made. |
|
N/A |
Additional (5)
| Parameter | Type | Presence | Purpose | Options | Default |
| FlowDirection | Optional | The traffic flow direction. Used only with type=NetflowBandwidth (or type=NetflowBandwidth, which is exactly the same). |
|
All | |
| Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings. For dates, C# date formats are supported, plus two special values (in any casing): 'format=dayOfWeek' for the day of the week as a number (Sunday = 0; use 'format=dddd' for the day name) and 'format=epoch' for the number of seconds since 1970-01-01 UTC. | N/A | N/A | |
| Int32 | Optional | If auto-titling the graph, the heading level to use. |
|
N/A |
Conditional Formatting (35)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The macro is considered 'critical' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'critical' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is not equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'error' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is not equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'fatal' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is not equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'info' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is not equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'warning' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is not equal to this value. | N/A | N/A |
Chart (5)
| Parameter | Type | Presence | Purpose | Options | Default |
| 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 | |
| String | Conditional | The graph name. If set, do not set the 'graphId' parameter. | N/A | N/A | |
| InterLineGraphDataAggregation | Conditional | How to combine the lines when 'aggregateOverDevices' or 'aggregateOverDataSourceInstances' is true. All, the default, shows every line without combining them. At a time when none of the lines has a value, every aggregation except Count gives no value, rather than 0. |
|
All | |
| Int32 | Conditional | The overview graph ID. | N/A | N/A | |
| String | Conditional | The overview graph name. | N/A | N/A |
Time & Date (6)
| Parameter | Type | Presence | Purpose | Options | Default |
| DateTimeOffset | Optional | The end date in the format YYYY-MM-DD. | N/A | Midnight on the first day of this month | |
| Boolean | Optional | Whether to include forecast data. |
|
false | |
| String | Optional | The time to forecast. |
|
7days | |
| String | Optional | The amount of data to use to inform the forecast. |
|
1month | |
| Int32 | Optional | If set, sets 'endDate' to the 'start' plus the specified number of months. | N/A | N/A | |
| DateTimeOffset | Optional | The start date in the format YYYY-MM-DD. | N/A | Midnight on the first day of last month |
Filtering & Sorting (1)2 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| 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. |
|
false |
Additional (2)
| Parameter | Type | Presence | Purpose | Options | Default |
| List<String> | Optional | The graph lines to leave out, named as for 'includeDataPoint'. | N/A | N/A | |
| List<String> | Optional | The graph lines to include, using each line's name as LogicMonitor shows it, such as Inbound : Number of inbound bits/sec. The device, instance and aggregation that a chart's legend can add are not part of the name. | N/A | N/A |
Output (2)8 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Char | Optional | The output value delimiter to use if multiple aggregations are requested. | N/A | ; | |
| 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. |
|
false |
Additional (8)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message. | N/A | N/A | |
| String | Optional | The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message. | N/A | N/A | |
Normal mode |
Boolean | Optional | Any macros that output lists can optionally (in Normal mode) output a jArray instead. |
|
true |
| String | Optional | The variable to store the result as. If the variable name ends 'Json' (any casing) its value is wrapped in json tags. That marks the value as JSON so it can be passed straight into a parameter that expects json content, and the RMScript editor also displays it with JSON highlighting. When several variables are stored at once each one is judged by its own name. | N/A | N/A | |
| String | Optional | The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. | N/A | N/A | |
| Char | Optional | The delimiter used by storeAs to split a TEXT value, 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=*]. If splitting on this delimiter does not produce one value per variable, the '^' character is tried instead; that applies whatever this parameter is set to, and is what allows a single variable to hold a value containing a ';'. Note this delimiter is only used for a TEXT value. A list or a JSON array is instead shared out one element per variable, and a JSON object by its property values in order, so storing jObject('a',1,'b',2) as two variables gives 1 and 2. Any other type cannot be split across several variables at all. | N/A | ; | |
| 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. As with 'storeAs', a name ending 'Json' has its value wrapped in json tags. | N/A | N/A | |
| Boolean | Optional | Whether to write output to a spreadsheet. |
|
N/A |
General (3)21 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| 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. |
|
N/A | |
| String | Mandatory | The LogicMonitor graph DataPoint (the name of the datapoint on the graph legend). | N/A | N/A | |
| 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 |
Additional (21)
| Parameter | Type | Presence | Purpose | Options | Default |
| Int32 | Conditional | The DataSource instance group id. If set, the dataSource parameter must also be set. | N/A | N/A | |
| String | Conditional | The DataSource instance group name. If set, the dataSource parameter must also be set. | N/A | N/A | |
| Int32 | Conditional | The DataSource instance ID. If set, the dataSource parameter must also be set. | N/A | N/A | |
| String | Conditional | The DataSource instance name. If set, the dataSource parameter must also be set. | N/A | N/A | |
| String | Conditional | The DataSource name. | N/A | N/A | |
| List<String> | Conditional | The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint). | N/A | N/A | |
| List<String> | Conditional | The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint). | N/A | N/A | |
| 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 | |
| Boolean | Optional | Whether to combine the lines of the DataSource instances, using the aggregation set by 'interLineAggregation'. On its own, each Device keeps its own lines, one per graph line, combining that Device's instances: for example, a switch's total traffic across all of its interfaces. With 'aggregateOverDevices' as well, everything is combined into one line per graph line. |
|
false | |
| Boolean | Optional | Whether to combine the lines of the Devices, using the aggregation set by 'interLineAggregation'. On its own, each DataSource instance keeps its own lines, one per graph line, combined across the Devices. With 'aggregateOverDataSourceInstances' as well, everything is combined into one line per graph line. |
|
false | |
| Boolean | Optional | Whether to auto title the graph. |
|
true | |
| String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
| String | Optional | The name of the Connection. | N/A | N/A | |
| Int32 | Optional | The DataSource ID. | N/A | N/A | |
| 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 | |
| List<Int32> | Optional | The Device ID or IDs. | N/A | N/A | |
| List<String> | Optional | The Device Display name or names. | N/A | N/A | |
| 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 | |
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. |
|
false |
| 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 | |
| List<Int32> | Optional | The Website ID or IDs. | N/A | N/A |
Deprecated (1)18 additional
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| 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. |
|
N/A |
Additional (18)
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| String | dataSourceName | The DataSource name. | N/A | N/A | |
| List<String> | websiteCheckPointName | The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint). | N/A | N/A | |
| List<String> | websiteCheckPointName | The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint). | N/A | N/A | |
| List<String> | websiteName | The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint). | N/A | N/A | |
| List<String> | websiteName | The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint). | N/A | N/A | |
| List<String> | websiteCheckPointName | The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint). | N/A | N/A | |
| List<String> | websiteName | The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint). | N/A | N/A | |
| Int32 | titleHeadingLevel | If auto-titling the graph, the heading level to use. |
|
N/A | |
| List<String> | devices | The Device Display name or names. | N/A | N/A | |
| 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 | |
| List<Int32> | deviceIds | The Device ID or IDs. | N/A | N/A | |
| 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 | |
| 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 | |
| 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 | |
| List<String> | devices | The Device Display name or names. | N/A | N/A | |
| List<Int32> | deviceIds | The Device ID or IDs. | N/A | N/A | |
| List<String> | devices | The Device Display name or names. | N/A | N/A | |
| List<Int32> | websiteIds | The Website ID or IDs. | N/A | N/A |
Examples (10)
Example 1
[LogicMonitor.SummaryValue: device=dev.panoramicdata.com, graphName=CPU Usage, dataSourceName=WinCPU, dataPoint=Busy, aggregations=Min;Mean;Max]Example 2
[LogicMonitor.SummaryValue: device=pdl-dr-prod-01, graphName=CPU, dataSourceInstanceName=NetSNMPCPU, dataPoint=UserPercent, aggregations=Mean]Example 3
[LogicMonitor.SummaryValue: device=pdl-dr-prod-01, graphName=CPU, dataSourceInstanceName=NetSNMPCPU, dataPoint=UserPercent, aggregations=PercentConditionMet(value>5), aggregateOverDevices=true]Example 4
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:
[LogicMonitor.SummaryValue: device=pdl-dr-prod-01, graphName=CPU, dataSourceInstanceName=NetSNMPCPU, dataPoint=UserPercent, aggregations=PercentConditionMet(value>5), outputDateTimes=true, aggregateOverDevices=true]Example 5Normal mode
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]Example 6
[LogicMonitor.SummaryValue: device=pdl-dr-prod-01, graphName=CPU, dataSourceInstanceName=NetSNMPCPU, dataPoint=UserPercent, aggregations=CountConditionMet(value>5), aggregateOverDevices=true]Example 7
[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:]