ReportMagic

[LogicMonitor.PercentageAvailability:]

Insert a single figure representing percentage DataSource availability.

Purpose

Use the PercentageAvailability macro to give a single figure representing availability of a device or device-DataSource by getting a list of all Alerts, filtered by an AlertsFilter and determining the amount of time that it was NOT in an alerting state. If you provide no filter criteria, alerts at Error level and above are used for the calculation.

Compatibility

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

Usage

More details about alert macros can be found at https://reportmagic.blogspot.com/p/reportmagic-alert-macros.html.

Parameters (200)

Grouped View

Behaviour (2)13 additional

Parameter	Type	Presence	Purpose	Options	Default
maxAttempts	Int32	Optional	The maximum number of attempts when requesting data via the LogicMonitor API.	From 1 to 2147483647	N/A
waitDuringUpgrades	Boolean	Optional	Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).	true false	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
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
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
minimumInstanceCount	Int32	Optional	Only include Instance Groups with an instance count of this number or more.	N/A	0
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
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 (6)

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
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

Formatting (7)

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
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
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 (4)

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
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 (10)

Parameter	Type	Presence	Purpose	Options	Default
level	AlertLevel	Conditional	Only include alerts at this level or above.	Error All Warning Critical DoMapping Any	Error
ackFilter	AckFilter	Optional	All: Both non-acknowledged alerts and acknowledged alerts will be returned. Acked: Alerts that have been acknowledged will be returned. Nonacked: Alerts that have not been acknowledged will be returned.	All Acked Nonacked	All
excludeDataPoint	List<String>	Optional	The datapoints to exclude.	N/A	N/A
excludeSdt	Boolean	Optional	Whether to exclude periods of SDT from the macro results. Only works for Devices (not Websites, etc.). For the most accurate results, ensure that you have LogicMonitor permissions for ALL the Device Groups that the Devices are members of. When this is not the case, those Device Groups will simply be skipped.	true false	false
includeDataPoint	List<String>	Optional	The datapoints to include.	N/A	N/A
includeInactive	Boolean	Optional	true: Historical alert records will be returned (i.e. both active and inactive alert details). false: Only active alert details will be returned.	true false	true
orderBy	String	Optional	The order the alerts should be retrieved in.	N/A	StartOnSeconds
orderDirection	OrderDirection	Optional	The direction of the order the alerts should be retrieved in.	Desc Asc	Desc
skip	Int32	Optional	The number of items to skip.	N/A	N/A
take	Int32	Optional	The maximum number to take.	N/A	N/A

Output (9)

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
listDelimiter	Char	Optional	The delimiter to use between multiple Instance Groups in the output.	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=abcd, 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 (4)39 additional

Parameter	Type	Presence	Purpose	Options	Default
instanceCount	Int32	Conditional	At present, this macro requires that you pre-calculate the number of instances to include in the query when the aggregation is set to 'Instance'.	N/A	N/A
monitorObjectCount	Int32	Conditional	At present, this macro requires that you pre-calculate the number of monitored objects to include in the query when the aggregation is set to 'MonitorObject'.	N/A	N/A
aggregation	PercentageAvailabilityAggregation	Optional	How to aggregate availability. 'All' : the percentage of the reporting period where there are NO alerts active. 'MonitorObject' : The availability is calculated for each monitored object and the mean is returned. 'Instance' : The availability is calculated for each instance and the mean is returned.	All MonitorObject Instance	All
connectionName	String	Optional	The name of the LogicMonitor Connection.	N/A	N/A

Additional (39)

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
resourceTemplateId	Int32	Conditional	Only include alerts relating to a LogicModule with this Id. WARNING! Multiple LogicModules could have the same Id. Only use with useCache=true.	N/A	N/A
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
ackCommentMatchesRegex	Regex	Optional	If present, only alerts with acknowledgement comments matching the regular expression are included.	N/A	N/A
alertTypes	List<String>	Optional	The semicolon-separated list of alertTypes to fetch. Options are: 'AlertThrottled', 'BatchJob', 'CollectorDown', 'CollectorFailBack', 'CollectorFailover', 'DataSource', 'EventSource', 'Log', 'ResourceCluster', 'Unknown' or 'Website'.	N/A	N/A
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
dataPoint	String	Optional	The name of the dataPoint that you want to retrieve alert data for.	N/A	N/A
dataSource	String	Optional	The DataSource unique name.	N/A	N/A
dataSourceId	Int32	Optional	The DataSource ID.	N/A	N/A
dataSourceInstance	String	Optional	The Datasource Instance e.g. WinVolumeUsage-F:	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
id	String	Optional	The specific unique alert ID to fetch.	N/A	N/A
maximumInstanceCount	Int32	Optional	Only include Instance Groups with an instance count or this number or fewer.	N/A	2147483647
minimumDurationMinutes	Int32	Optional	Filter alerts where the alert has been active for more than the specified number of minutes.	N/A	N/A
monitorObjectDisplayName	String	Optional	The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId.	N/A	N/A
monitorObjectId	Int32	Optional	Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary.	N/A	N/A
monitorObjectType	MonitorObjectType	Optional	Determines whether the monitored object in question is a Device or a Website, when specifying the Monitor Object ID and 'useCache=false'. This is necessary because there are specific LogicMonitor API calls to fetch alerts that are used in each case, in order to ensure that, for example, a Device that has had its name changed can still be queried for all alerts by its ID. Just specifying the Monitor Object ID alone is insufficient to determine the type.	Device Other Website	Device
problemSignature	String	Optional	Only include alerts matching this problem signature (InternalId).	N/A	N/A
resourceGroupName	String	Optional	Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder.	N/A	N/A
resourceTemplateDisplayName	String	Optional	Only include alerts relating to a LogicModule with this Display Name (NOT unique name). WARNING! Multiple LogicModules (even of the same type) could have the same display name.	N/A	N/A
resourceTemplateDisplayNameMatchesRegex	Regex	Optional	If present, only alerts with a resource template name matching the regular expression are included.	N/A	N/A
sdted	SdtFilter	Optional	Filter alerts by SDT status where SDT means only include alerts created during SDT in the results, NonSdt means only include alerts created outside SDT in the results and All shows all alerts.	All Sdt NonSdt	All
serviceId	Int32	Optional	DEPRECATED	N/A	N/A
serviceName	String	Optional	DEPRECATED	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 (31)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
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
alertType	List<String>	alertTypes	The semicolon-separated list of alertTypes to fetch. Options are: 'AlertThrottled', 'BatchJob', 'CollectorDown', 'CollectorFailBack', 'CollectorFailover', 'DataSource', 'EventSource', 'Log', 'ResourceCluster', 'Unknown' or 'Website'.	N/A	N/A
autoTitleHeadingLevel	Int32	titleHeadingLevel	If auto-titling the graph, the heading level to use.	From 1 to 6	N/A
collectorId	Int32	monitorObjectId	Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary.	N/A	N/A
dataSourceInstanceName	String	dataSourceInstance	The Datasource Instance e.g. WinVolumeUsage-F:	N/A	N/A
dataSourceName	String	dataSource	The DataSource unique name.	N/A	N/A
device	String	monitorObjectDisplayName	The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId.	N/A	N/A
device	List<String>	devices	The Device Display name or names.	N/A	N/A
deviceGroup	String	resourceGroupName	Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder.	N/A	N/A
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	Int32	monitorObjectId	Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary.	N/A	N/A
deviceId	List<Int32>	deviceIds	The Device ID or IDs.	N/A	N/A
deviceName	String	monitorObjectDisplayName	The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId.	N/A	N/A
filterSDT	SdtFilter	sdted	Filter alerts by SDT status where SDT means only include alerts created during SDT in the results, NonSdt means only include alerts created outside SDT in the results and All shows all alerts.	All Sdt NonSdt	All
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	String	resourceGroupName	Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder.	N/A	N/A
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.	N/A	N/A
host	String	monitorObjectDisplayName	The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId.	N/A	N/A
host	List<String>	devices	The Device Display name or names.	N/A	N/A
hostId	List<Int32>	deviceIds	The Device ID or IDs.	N/A	N/A
hosts	List<String>	devices	The Device Display name or names.	N/A	N/A
internalId	String	problemSignature	Only include alerts matching this problem signature (InternalId).	N/A	N/A
results	Int32	take	The maximum number to take.	N/A	N/A
websiteId	Int32	monitorObjectId	Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary.	N/A	N/A
websiteId	List<Int32>	websiteIds	The Website ID or IDs.	N/A	N/A

Examples (7)

Example 1

How available was the development server? (any alert state at Error level and above is considered non-availability):

[LogicMonitor.PercentageAvailability: device=dev.panoramicdata.com]

Example 2

Now, only consider CPU issues:

[LogicMonitor.PercentageAvailability: device=dev.panoramicdata.com, dataSourceName=WinCPU]

Example 3

Now, only consider Critical CPU issues:

[LogicMonitor.PercentageAvailability: device=dev.panoramicdata.com, dataSourceName=WinCPU, level=Critical]

Example 4

Now, only consider one of the cores:

[LogicMonitor.PercentageAvailability: device=dev.panoramicdata.com, dataSourceInstanceName=WinCPU-0, level=Critical]

Example 5

Include inactive issues:

[LogicMonitor.PercentageAvailability: device=dev.panoramicdata.com, dataSourceName=WinCPU, includeInactive=true]

Example 6

Use the MonitorObject aggregation:

[LogicMonitor.PercentageAvailability: device=dev.panoramicdata.com, dataSourceName=WinCPU, aggregation=MonitorObject, monitorObjectCount=10]

Example 7

Use the Instance aggregation:

[LogicMonitor.PercentageAvailability: device=dev.panoramicdata.com, dataSourceName=WinCPU, aggregation=Instance, instanceCount=10]