ReportMagic

[LogicMonitor.GraphSpecification:]

Obtains the specification of a LogicMonitor graph.

Compatibility

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

Usage

This macro always operates in Normal Mode and outputs a single JObject, which can be manipulated and even passed to the [Object.Graph:] macro. You could also use the data inside the JObject to update Word and PowerPoint charts, using the [Graph.Update:] macro. All the same parameters as the [LogicMonitor.Graph:] macro are supported, so you can use the same examples but just change the macro name.

Parameters (228)

Grouped View

Behaviour (1)9 additional

Parameter	Type	Presence	Purpose	Options	Default
recurseDeviceGroups	Boolean	Optional	Whether to recurse Device Groups. Specify false to exclude child Device Groups.	true false	true

Additional (9)

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
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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
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 (4)

Parameter	Type	Presence	Purpose	Options	Default
customPaletteHexCodes	String	Conditional	When the 'overridePaletteType' parameter is set to 'Custom', you must specify a semi-colon separated list of HTML-style hex codes (or HTML colour names such as red), e.g. #FF0000;#00FF00;#0000FF (with or without the hash) to use as a custom override palette, which will apply to each line series plotted. This parameter is ignored unless you use 'overridePaletteType=Custom'.	N/A	N/A
labelBackgroundColor	Color	Optional	The label background color	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
labelColor	Color	Optional	The label color	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
palette	List<String>	Optional	A list of html-encoded (hex codes) colours for each series separated by ^ for the series name and colour, and semicolons for each series (see examples below). If not specified, a default Microsoft palette will be used. The 'OverridePaletteType' parameter will, if set, override this parameter.	N/A	Yes^#0d0;No^#d00;True^#0d0;False^#d00;OK^#0d0;Error^#d00;Unknown^#ddd

Formatting (2)17 additional

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
titleHeadingLevel	Int32	Optional	If auto-titling the graph, the heading level to use.	From 1 to 6	N/A

Additional (17)

Parameter	Type	Presence	Purpose	Options	Default
imageHeightCm	Double	Conditional	The image height in centimetres (cm). If this is set, so should 'imageWidthCm' be. For Word output, this is equivalent to setting an absolute height in cm without locking the aspect ratio.	N/A	N/A
imageWidthCm	Double	Conditional	The image width in centimetres. If this is set, so should 'imageHeightCm' be. For Word output, this is equivalent to setting an absolute with in cm without locking the aspect ratio.	N/A	N/A
clipBottom	Double	Optional	The number of pixels to clip from the bottom of the image. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	N/A	N/A
clipLeft	Double	Optional	The number of pixels to clip from the left of the image. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	N/A	N/A
clipRight	Double	Optional	The number of pixels to clip from the right of the image. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	N/A	N/A
clipTop	Double	Optional	The number of pixels to clip from the top of the image. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	N/A	N/A
hAlign	PowerPointImageHorizontalAlign	Optional	For PowerPoint output only, the ability to horizontally align images produced by macros, with vertical lines. No other image parameters apply (clipping, etc.). Does not work with the default Emf image formats, so using this parameter uses the default Png format instead.	Center Left Right	N/A
horizontalPositionAlignment	HorizontalPositionAlignment	Optional	The horizontal position alignment.	Left Inline Center Right Inside Outside	Left
horizontalPositionRelativeTo	HorizontalPositionRelativeTo	Optional	What the horizontal position is relative to.	Inline Margin Column Page InsideMargin OutsideMargin LeftMargin RightMargin	Inline
opacityPercent	Double	Optional	The image opacity (0 is transparent, 100 is solid).	From 0 to 100	100
pageHeightPercent	Double	Optional	The height of the page to take up with the graph. Always overrides 'imageHeightCm'	From 0 to 300	N/A
pageWidthPercent	Double	Optional	The width of the page to take up with the graph. Always overrides 'imageWidthCm'	From 0 to 300	N/A
vAlign	PowerPointImageVerticalAlign	Optional	For PowerPoint output only, the ability to vertically align images produced by macros, with horizontal lines. No other image parameters apply (clipping, etc.). Does not work with the default Emf image formats, so using this parameter uses the default Png format instead.	Bottom Middle Top	N/A
verticalPositionAlignment	VerticalPositionAlignment	Optional	The Vertical position alignment.	Top Inline Center Bottom Inside Outside	Top
verticalPositionRelativeTo	VerticalPositionRelativeTo	Optional	What the vertical position is relative to.	Inline Page Paragraph Margin BottomMargin InsideMargin OutsideMargin TopMargin	Inline
wrapping	Wrapping	Optional	Image wrapping.	Inline BehindText	Inline
xlsxTableStyle	XlsxTableStyle	Optional	The XLSX table style to use in any XLSX output document.	TableStyleMedium13 None TableStyleDark1 TableStyleDark10 TableStyleDark11 TableStyleDark2 TableStyleDark3 TableStyleDark4 TableStyleDark5 TableStyleDark6 TableStyleDark7 TableStyleDark8 TableStyleDark9 TableStyleLight1 TableStyleLight10 TableStyleLight11 TableStyleLight12 TableStyleLight13 TableStyleLight14 TableStyleLight15 TableStyleLight16 TableStyleLight17 TableStyleLight18 TableStyleLight19 TableStyleLight2 TableStyleLight20 TableStyleLight21 TableStyleLight3 TableStyleLight4 TableStyleLight5 TableStyleLight6 TableStyleLight7 TableStyleLight8 TableStyleLight9 TableStyleMedium1 TableStyleMedium10 TableStyleMedium11 TableStyleMedium12 TableStyleMedium14 TableStyleMedium15 TableStyleMedium16 TableStyleMedium17 TableStyleMedium18 TableStyleMedium19 TableStyleMedium2 TableStyleMedium20 TableStyleMedium21 TableStyleMedium22 TableStyleMedium23 TableStyleMedium24 TableStyleMedium25 TableStyleMedium26 TableStyleMedium27 TableStyleMedium28 TableStyleMedium3 TableStyleMedium4 TableStyleMedium5 TableStyleMedium6 TableStyleMedium7 TableStyleMedium8 TableStyleMedium9	TableStyleMedium13

Chart (10)116 additional

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
autoScaleBoundaryLabels	Boolean	Optional	Use short (auto-scaled) labels for boundary legend items. When set, the 'boundaryLabelFormat' parameter is ignored.	true false	true
autoScaleBoundaryLabelsAreData	Boolean	Optional	Whether the short (auto-scaled) boundary legend values represent 'data' (B, KB, MB, GB, and TB) and so 1024 is used as a multiplier, rather than 1000. When not representing data, the labels used are: K, M, B, and T. Has no effect unless the 'autoScaleBoundaryLabels' parameter is used.	true false	false
autoYAxisFromType	GraphAutoYAxisFromType	Optional	When set to ReportMagic, it ignores the 'yAxisMinimum' and 'yAxisMaximum' parameters, and those in the LogicMonitor graph, but instead focuses (effectively zooms in) more closely on the data's actual min/max, which can more clearly illustrate small variations in the data.	LogicMonitor ReportMagic	LogicMonitor
boundaryLabelFormat	String	Optional	The number format for the min/max/mean values of LogicMonitor boundaries when used in the graph's legend titles. ONLY applies when 'showBoundaries' is used and applicable, otherwise ignored.	N/A	F2
showBoundaries	Boolean	Optional	Whether to include the LogicMonitor boundaries in the legend titles. ONLY applies when 'type' is 'DashboardWidget'.	true false	false

Additional (116)

Parameter	Type	Presence	Purpose	Options	Default
chartTypes	List<String>	Conditional	The type(s) of chart. You can specify more than one (separated by a semi-colon). If you specify fewer than the number of series, the last value will continue to be used for the remainder of the series. Permitted values: Point, FastPoint, Line, Spline, StepLine, FastLine, Bar, StackedBar, StackedBar100, Column, StackedColumn, StackedColumn100, Area, SplineArea, StackedArea, StackedArea100, Pie, Doughnut, Radar, Polar, BoxPlot, Funnel, Pyramid. For Pie and Doughnut chart types, the first column provides the slice name, the second column the slice size and all other columns are ignored.	N/A	N/A
xAxisTitle	String	Conditional	Set the X Axis Label to the provided text. Required for all chartTypes, except 'Pie' and 'Doughnut'.	N/A	N/A
yAxisTitle	String	Conditional	Set the Y Axis Label to the provided text. Required for all chartTypes, except 'Pie' and 'Doughnut'.	N/A	N/A
autoScaleYAxisLabels	Boolean	Optional	Whether to use short (auto-scaled) labels in Y-axes (e.g. 10K instead of 10000). Only has an effect when the 'yAxisLabelFormat' parameter is NOT set.	true false	true
autoScaleYAxisLabelsAreData	Boolean	Optional	Whether the short (auto-scaled) labels in Y-axes represent 'data'. In that case these labels are used: B, KB, MB, GB, and TB. When not representing data, the labels used are: K (thousands), M (millions), B (billions), and T (trillions). Only has an effect when 'autoScaleYAxisLabels' is true (the default for that parameter), otherwise ignored.	true false	false
chartAreaBackgroundColor	Color	Optional	The chart area background color	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
chartAreaHeightPercent	Int32	Optional	The ChartAreaHeightPercent	From 0 to 100	100
chartAreaWidthPercent	Int32	Optional	The ChartAreaWidthPercent	From 0 to 100	80
chartAreaXPosition	Int32	Optional	The ChartAreaXPosition	From 0 to 100	0
chartAreaYPosition	Int32	Optional	The ChartAreaYPosition	From 0 to 100	0
chartBackgroundColor	Color	Optional	The chart background color	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
chartBorderLineColor	Color	Optional	The chart border line color	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.	Color [Black]
chartBorderLineDashStyle	ChartDashStyle	Optional	The chart border line dash style	Solid NotSet Dash DashDot DashDotDot Dot	Solid
chartBorderLineWidth	Int32	Optional	The chart border line width	N/A	0
chartHeight	Int32	Optional	The chart height in pixels	From 1 to 8000	400
chartImageFormat	ChartImageFormat	Optional	The chart image format	EmfPlus Jpeg Png Bmp Tiff Gif Emf EmfDual	EmfPlus
chartWidth	Int32	Optional	The chart width in pixels	From 1 to 8000	2560
doughnutRadius	Int32	Optional	Optionally use to specify the doughnut radius when specifying 'chartType=Doughnut'.	From 0 to 99	60
dynamicYAxis	Boolean	Optional	Whether to more closely show the y-axis variance on charts. Use the 'dynamicYAxisVariancePercent' parameter to control the variance percentage. When set, the 'yAxisMinimum' and 'yAxisMaximum' parameters are ignored. When this parameter is set, the 'yAxisIsLogarithmic' parameter is ignored.Note: when the minimum data value is 0, the y-axis minimum is NOT adjusted.	true false	false
dynamicYAxisVariancePercent	Double	Optional	The variance percentage to use in conjunction with the 'dynamicYAxis' parameter to adjust the y-axis scale. For example, if the maximum y-axis data value was 10 and this parameter was set to 5, then the y-axis maximum is set to 10 + (5% of 10), which is 10.5. When this parameter and 'dynamicYAxis' is set, the 'yAxisMinimum' and 'yAxisMaximum' parameters are ignored.When this parameter and 'dynamicYAxis' is set, the 'yAxisIsLogarithmic' parameter is ignored. NOTE: final y-axis minimum and maximum values will be rounded to the nearest integer (whole number)	From 0 to 100	1.5
enable3d	Boolean	Optional	Whether to enable 3D.	true false	false
ensureColorsUnique	Boolean	Optional	Whether to ensure the colours of all series in the chart are unique. Note that unique colours are still selected if no palette is provided for any series.	true false	false
fixedLines	List<FixedLine>	Optional	The semicolon-delimited list of lines of fixed y-value to add to the graph. Each should be in the format "name^value^color", e.g. fixedLines=Lower95th^10^Red;Mean^50^Blue;Upper95th^90^Red	N/A	N/A
inclination3dDegrees	Int32	Optional	The inclination in degrees. Only valid when enable3d is set to true.	From -90 to 90	50
innerPlotHeightPercent	Int32	Optional	The InnerPlotHeightPercent	From 0 to 100	75
innerPlotWidthPercent	Int32	Optional	The InnerPlotWidthPercent	From 0 to 100	85
innerPlotXPosition	Int32	Optional	The InnerPlotXPosition	From 0 to 100	10
innerPlotYPosition	Int32	Optional	The InnerPlotYPosition	From 0 to 100	10
labelFontSize	Double	Optional	Set the chart label font size.	From 5 to 100	16
labels	List<String>	Optional	Optionally use to specify labels to add to the chart, formatted as: text^X^Y^alignment^font^fontSize^fontStyle^fontColor. Supported fonts are: 'Arial, Calibri, Comic Sans MS, and Ms Sans Serif'. Supported fontStyles are 'Regular, Bold, Italic, Underline, Strikeout'. Supported alignments are TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight. Font colours can be named fonts (such as Red) or hex-based colours (ARGB or RGB-formatted such as #FF0000 or #FFFF0000 for red). Note that alpha component is optional.	N/A	N/A
labelText	String	Optional	Optionally use to specify the label text. Options include #PERCENT{P0} (e.g. for Pie/doughnut charts), #VALX and #VALY. The {P-number} specifies the number of decimal places to display. You can combine these and other symbols (e.g. '#VALX\n(#PERCENT %)' ).	N/A	N/A
legendBackgroundColor	Color	Optional	The legend background color	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
legendBorderColor	Color	Optional	The legend border color	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
legendFontSize	Double	Optional	Set the chart legend font size (default autofit).	From 5 to 100	20
legendHeightPercent	Int32	Optional	The LegendHeightPercent	From 0 to 100	100
legendStyle	LegendStyle	Optional	The legend style	Column Row Table	Column
legendText	String	Optional	Optionally use to specify the label legend text. For other options, see the labelText parameter.	N/A	N/A
legendTextWrapThreshold	Int32	Optional	The number of characters that can be placed in a legend item before text wrapping occurs. Wrapping uses a 'word-break' method, so if the legend names do NOT contain spaces, no wrapping will occur.	From 0 to 2147483647	25
legendWidthPercent	Int32	Optional	The LegendWidthPercent	From 0 to 100	20
legendXPosition	Int32	Optional	The LegendXPosition	From 0 to 100	80
legendYPosition	Int32	Optional	The LegendYPosition	From 0 to 100	0
lineWidth	Int32	Optional	The line width	From 1 to 10	2
markerBorderColors	List<Color>	Optional	Set the border color(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerBorderWidths	List<Int32>	Optional	Set the border width(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerColors	List<Color>	Optional	Set the color(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerSizes	List<Int32>	Optional	Set the size(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerStyles	List<MarkerStyle>	Optional	Set the marker style(s) (for example, on line charts) If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
orderAreaChartSeriesByMean	Boolean	Optional	For charts where all the series are areas (not stacked), order the series according to the mean y-axis values (largest first, descending). This is useful for charts where, depending on the data, 'larger' series would be rendered in front of smaller ones, thereby obscuring them in the chart.	true false	false
overridePaletteType	OverridePaletteType	Optional	Force series colours to use various alternative palettes. Overrides all other settings such as 'EnsureColorsUnique'. When there are more series than the count of colours in each palette, the colours chosen will start again from the beginning of the palette. This parameter is useful for series where there are no colours set (or set to 'Auto' in LogicMonitor Widget graphs, for example).	Default Custom LogicMonitor RainbowStandard RainbowExtended	Default
perspective3dPercent	Int32	Optional	The perspective in percent. Only valid when enable3d is set to true.	From 0 to 100	0
pieCollectedColor	Color	Optional	Optionally use to specify the color of the collected ('other') pie slice.	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.	Color [LightGray]
pieCollectedLabel	String	Optional	Optionally use to specify the label for the collected ('other') pie slice.	N/A	Other
pieCollectedThresholdPercent	Double	Optional	Optionally use to specify the percentage threshold for the collected ('other') pie slice.	From 0 to 100	5
pieLabelStyle	PieLabelStyle	Optional	Optionally use to specify the doughnut label style when specifying 'chartType=Doughnut' or 'chartType=Pie'.	Inside Outside Disabled	Inside
pieLineColor	Color	Optional	Optionally use to specify the pie or doughnut line color when using 'pieLabelStyle=Outside'.	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.	Color [LightGray]
pieStartAngleDegrees	Int32	Optional	Optionally use to specify the pie or doughnut start angle in degrees from the top.	From 0 to 359	0
pointDepth3dPercent	Int32	Optional	The point depth as a percentage. Only valid when enable3d is set to true.	From 0 to 1000	100
pointGapDepth3dPercent	Int32	Optional	The point gap depth as a percentage. Only valid when enable3d is set to true.	From 0 to 1000	100
pointWidthPercent	Double	Optional	For Bar and Column series only, the gap between each item as a percentage (0 - 100) of the available space. If not set, the default of 80% is used.	From 0 to 100	N/A
rotation3dDegrees	Int32	Optional	The rotation in degrees. Only valid when enable3d is set to true.	From -90 to 90	30
useChartMagic	Boolean	Optional	Whether to use ChartMagic (experimental)	true false	false
xAxisFontColor	Color	Optional	Optionally use to specify the x axis font color.	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.	Color [Black]
xAxisFontSize	Double	Optional	Set the chart x-axis font size (default autofit).	From 5 to 100	20
xAxisHeightPercent	Double	Optional	Set the chart's maximum x-axis height as a percent of the chart area. By default, an automatic choice is made. This is used by the automatic layout algorithm and means that this height value may NOT be used, if unnecessary, so represents the 'maximum auto-size'.	From 0 to 90	N/A
xAxisInterval	Double	Optional	The x-axis interval. Only works for whole numbers such as 1, 2, etc. (unpredictable results otherwise).	N/A	N/A
xAxisIntervalAutoMode	IntervalAutoMode	Optional	Optionally use to specify the x axis's interval auto mode.	FixedCount VariableCount	FixedCount
xAxisIntervalType	DateTimeIntervalType	Optional	Optionally use to specify the x axis's interval type. The 'xAxisInterval' parameter is ignored when this parameter is 'Auto' (the default). It is recommended that if you know the type of the date-oriented x-axis (such as months) then you set this parameter accordingly e.g. xAxisIntervalType=Months, and xAxisInterval=1 (to display each month on the x-axis).	Auto Number Years Months Weeks Days Hours Minutes Seconds Milliseconds NotSet	Auto
xAxisIsAutoFit	Boolean	Optional	Whether the x axis's labels are automatically fitted.	true false	true
xAxisIsMarginVisible	Boolean	Optional	Overrides the default x-axis auto margin (which is true by default EXCEPT when there's an empty graph with 2 data points, e.g. a start and an end date). The auto margin extends the x-axis by the equivalent of 1 data point either side of the data, typically leaving a small gap between both interior sides of the axis and the data. Note that in the case of an EMPTY graph (no y-values, but where there is a date / data range), this can lead to an additional month each side of the axis, which may not be what you want to achieve. ReportMagic in this case AUTOMATICALLY disables the margins to produce the 'expected' x-axis range, hence why you may want to force this to true in case you do want the margins.	true false	N/A
xAxisLabelAngle	Int32	Optional	Optionally use to specify the x axis's label angle.	From -90 to 90	0
xAxisLabelAutoFitStyle	LabelAutoFitStyles	Optional	Optionally use to specify the X Axis label autofit style.	DecreaseFont None IncreaseFont StaggeredLabels LabelsAngleStep30 LabelsAngleStep45 LabelsAngleStep90 WordWrap	DecreaseFont
xAxisLabelFormat	String	Optional	The X Axis label format. See https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings for more details.	N/A	yyyy-MM-dd
xAxisLineColor	Color	Optional	The x axis line color.	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
xAxisLineDashStyle	ChartDashStyle	Optional	The x axis line dash style	Solid NotSet Dash DashDot DashDotDot Dot	Solid
xAxisLineWidth	Int32	Optional	The x axis line width.	N/A	N/A
xAxisMajorGridEnabled	Boolean	Optional	Whether the X-axis major grid is enabled.	true false	true
xAxisMajorGridInterval	Double	Optional	A number - if specified, you must also specify xAxisMajorGridIntervalType.	From 0 to 100	N/A
xAxisMajorGridIntervalType	DateTimeIntervalType	Optional	The major x-axis grid interval type.	Auto Days Hours Milliseconds Minutes Months NotSet Number Seconds Weeks Years	N/A
xAxisMajorGridLineColor	Color	Optional	Optionally specify a color for the x-axis major grid lines. If not specified, the default of Black is used.	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
xAxisMajorGridLineDashStyle	ChartDashStyle	Optional	Optionally specify a dash style for the x-axis major grid lines. If not specified, the default of Solid is used.	Dash DashDot DashDotDot Dot NotSet Solid	N/A
xAxisMajorGridLineWidth	Int32	Optional	Optionally specify a width in pixels for the x-axis major grid lines. If not specified, the default of 1 is used.	N/A	N/A
xAxisMinorGridEnabled	Boolean	Optional	Whether the X-axis Minor grid is enabled	true false	true
xAxisMinorGridInterval	Double	Optional	A number - (if specified, you must also specify xAxisMinorGridIntervalType)	From 0 to 100	N/A
xAxisMinorGridIntervalType	DateTimeIntervalType	Optional	The Minor x-axis grid interval type.	Auto Days Hours Milliseconds Minutes Months NotSet Number Seconds Weeks Years	N/A
xAxisMinorGridLineColor	Color	Optional	Optionally specify a color for the x-axis minor grid lines. If not specified, the default of LightGray is used.	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
xAxisMinorGridLineDashStyle	ChartDashStyle	Optional	Optionally specify a dash style for the x-axis minor grid lines. If not specified, the default of Solid is used.	Dash DashDot DashDotDot Dot NotSet Solid	N/A
xAxisMinorGridLineWidth	Int32	Optional	Optionally specify a width in pixels for the x-axis minor grid lines. If not specified, the default of 1 is used.	N/A	N/A
xValueType	ChartValueType	Optional	The x value type. You can set this to 'String' which will disable the 'Auto' mode for the 'xAxisIntervalType' parameter.	DateTime Auto Double Single Int32 Int64 UInt32 UInt64 String Date Time DateTimeOffset	DateTime
yAxisFontColor	Color	Optional	Optionally use to specify the y axis font color.	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.	Color [Black]
yAxisFontSize	Double	Optional	Set the chart y-axis font size (default autofit).	From 5 to 100	20
yAxisInterval	Double	Optional	The y-axis interval. Only works for whole numbers such as 1, 2, etc. (unpredictable results otherwise).	N/A	N/A
yAxisIntervalAutoMode	IntervalAutoMode	Optional	Optionally use to specify the y axis's interval auto mode.	FixedCount VariableCount	FixedCount
yAxisIntervalType	DateTimeIntervalType	Optional	Optionally use to specify the y axis's interval type.	Auto Number Years Months Weeks Days Hours Minutes Seconds Milliseconds NotSet	Auto
yAxisIsAutoFit	Boolean	Optional	Whether the y axis's labels are automatically fitted.	true false	true
yAxisIsLogarithmic	Boolean	Optional	Optionally use to specify that the Y Axis is logarithmic. Note that any y values of 0 or below will cause an error. You may need to manually adjust the yAxisMinimum parameter. When the 'dynamicYAxis' parameter is set, this parameter is ignored and the axis is forced NOT to be logarithmic.	true false	false
yAxisLabelAngle	Int32	Optional	Optionally use to specify the y axis's label angle.	From -90 to 90	0
yAxisLabelAutoFitStyle	LabelAutoFitStyles	Optional	Optionally use to specify the Y Axis label autofit style.	DecreaseFont None IncreaseFont StaggeredLabels LabelsAngleStep30 LabelsAngleStep45 LabelsAngleStep90 WordWrap	DecreaseFont
yAxisLabelFormat	String	Optional	The Y Axis label format. See https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings for more details. When this parameter is set, it overrides the 'autoScaleYAxisLabels' parameter (i.e. that one has no effect).	N/A	N/A
yAxisLineColor	Color	Optional	The y axis line color.	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
yAxisLineDashStyle	ChartDashStyle	Optional	The y axis line dash style	Solid NotSet Dash DashDot DashDotDot Dot	Solid
yAxisLineWidth	Int32	Optional	The y axis line width.	N/A	N/A
yAxisMajorGridEnabled	Boolean	Optional	Whether the Y-axis major grid is enabled	true false	true
yAxisMajorGridInterval	Double	Optional	A number - (if specified, you must also specify yAxisMajorGridIntervalType)	From 0 to 100	N/A
yAxisMajorGridIntervalType	DateTimeIntervalType	Optional	The major y-axis grid interval type.	Auto Days Hours Milliseconds Minutes Months NotSet Number Seconds Weeks Years	N/A
yAxisMajorGridLineColor	Color	Optional	Optionally specify a color for the y-axis major grid lines. If not specified, the default of Black is used.	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
yAxisMajorGridLineDashStyle	ChartDashStyle	Optional	Optionally specify a dash style for the y-axis major grid lines. If not specified, the default of Solid is used.	Dash DashDot DashDotDot Dot NotSet Solid	N/A
yAxisMajorGridLineWidth	Int32	Optional	Optionally specify a width in pixels for the y-axis major grid lines. If not specified, the default of 1 is used.	N/A	N/A
yAxisMaximum	Double	Optional	Sets the Y Axis maximum (default derived from graph data). When both yAxisMinimum and yAxisMaximum are set, if either are not whole numbers, this MAY cause chart data to be rendered incorrectly.	N/A	N/A
yAxisMinimum	Double	Optional	Sets the Y Axis minimum (default derived from graph data). This value MAY be automatically adjusted when 'yAxisIsLogarithmic=true' and the data contains any 0 values, to avoid chart errors (logarithmic charts may not contain y-axis values of 0 or below). When both yAxisMinimum and yAxisMaximum are set, if either are not whole numbers, this MAY cause chart data to be rendered incorrectly.	N/A	N/A
yAxisMinorGridEnabled	Boolean	Optional	Whether the Y-axis Minor grid is enabled	true false	true
yAxisMinorGridInterval	Double	Optional	A number - (if specified, you must also specify yAxisMinorGridIntervalType)	From 0 to 100	N/A
yAxisMinorGridIntervalType	DateTimeIntervalType	Optional	The Minor y-axis grid interval type.	Auto Days Hours Milliseconds Minutes Months NotSet Number Seconds Weeks Years	N/A
yAxisMinorGridLineColor	Color	Optional	Optionally specify a color for the y-axis minor grid lines. If not specified, the default of LightGray is used.	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
yAxisMinorGridLineDashStyle	ChartDashStyle	Optional	Optionally specify a dash style for the y-axis minor grid lines. If not specified, the default of Solid is used.	Dash DashDot DashDotDot Dot NotSet Solid	N/A
yAxisMinorGridLineWidth	Int32	Optional	Optionally specify a width in pixels for the y-axis minor grid lines. If not specified, the default of 1 is used.	N/A	N/A
yAxisWidthPercent	Double	Optional	Set the chart's maximum y-axis width as a percent of the chart area. By default, an automatic choice is made. This is used by the automatic layout algorithm and means that this height value may NOT be used, if unnecessary, so represents the 'maximum auto-size'.	From 0 to 90	N/A

Time & Date (3)3 additional

Parameter	Type	Presence	Purpose	Options	Default
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

Additional (3)

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

Parameter	Type	Presence	Purpose	Options	Default
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

Output (1)4 additional

Parameter	Type	Presence	Purpose	Options	Default
writeToSpreadsheet	Boolean	Optional	Whether to write output to a spreadsheet.	true false	N/A

Additional (4)

Parameter	Type	Presence	Purpose	Options	Default
emptyTableText	String	Optional	The text for the new tab in the Xlsx document if the table is empty.	N/A	N/A
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
storeAsHidden	String	Optional	The hidden (does not show in document output) variable in which to save the output graph as base64-encoded text. This is useful because the [Variable.Image:] macro can then insert it into any document. The image is generated only once but can then be manipulated repeatedly with a variety of image-related parameters. Note: when this variable is set, the image format will be forced to PNG, i.e. the equivalent of: chartImageFormat=Png. The image is saved without clippingt (i.e. without any clip parameters applied).	N/A	N/A

General (19)7 additional

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 set an auto-title, based on the LogicMonitor graph title.	true false	false
dataSourceId	Int32	Optional	The DataSource ID.	N/A	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
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
title	String	Optional	The optional chart title, to appear in text above the chart graphic.	N/A	N/A
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

Additional (7)

Parameter	Type	Presence	Purpose	Options	Default
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
description	String	Optional	The description for visually-impaired users. This text also displays when the user hovers the mouse over the image in Word or a PDF viewer.	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
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
worksheetName	String	Optional	The worksheet to save the result in the output Excel document (if so configured). Excel does not allow blank names, names above 31 characters, and the following characters: :, /, \, ?, *, [, ]	N/A	Table

Deprecated (19)10 additional

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
autoYAxisFrom	GraphAutoYAxisFromType	autoYAxisFromType	When set to ReportMagic, it ignores the 'yAxisMinimum' and 'yAxisMaximum' parameters, and those in the LogicMonitor graph, but instead focuses (effectively zooms in) more closely on the data's actual min/max, which can more clearly illustrate small variations in the data.	LogicMonitor ReportMagic	LogicMonitor
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.	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
websiteId	List<Int32>	websiteIds	The Website ID or IDs.	N/A	N/A

Additional (10)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
chartType	List<String>	chartTypes	The type(s) of chart. You can specify more than one (separated by a semi-colon). If you specify fewer than the number of series, the last value will continue to be used for the remainder of the series. Permitted values: Point, FastPoint, Line, Spline, StepLine, FastLine, Bar, StackedBar, StackedBar100, Column, StackedColumn, StackedColumn100, Area, SplineArea, StackedArea, StackedArea100, Pie, Doughnut, Radar, Polar, BoxPlot, Funnel, Pyramid. For Pie and Doughnut chart types, the first column provides the slice name, the second column the slice size and all other columns are ignored.	N/A	N/A
xAxisLabel	String	xAxisTitle	Set the X Axis Label to the provided text. Required for all chartTypes, except 'Pie' and 'Doughnut'.	N/A	N/A
yAxisLabel	String	yAxisTitle	Set the Y Axis Label to the provided text. Required for all chartTypes, except 'Pie' and 'Doughnut'.	N/A	N/A
markerBorderColor	List<Color>	markerBorderColors	Set the border color(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerBorderWidth	List<Int32>	markerBorderWidths	Set the border width(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerColor	List<Color>	markerColors	Set the color(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerSize	List<Int32>	markerSizes	Set the size(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerStyle	List<MarkerStyle>	markerStyles	Set the marker style(s) (for example, on line charts) If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
pointWidth	Double	pointWidthPercent	For Bar and Column series only, the gap between each item as a percentage (0 - 100) of the available space. If not set, the default of 80% is used.	From 0 to 100	N/A
useYAxisShortLabels	Boolean	autoScaleYAxisLabels	Whether to use short (auto-scaled) labels in Y-axes (e.g. 10K instead of 10000). Only has an effect when the 'yAxisLabelFormat' parameter is NOT set.	true false	true

Examples (1)

Example 1

This example produces the graph specification by using the [LogicMonitor.GraphSpecification:] macro, for Devices that exist in the LogicMonitor portal, and then runs the [Object.Graph:] macro to output the graph specification:

[ForEach: storeAs=orderby_forDeviceListmacro, values=Id;Link;NetflowCollectorId;PreferredCollectorId;CollectorDescription;EnableNetflow;AlertStatus;Status;CurrentCollectorId;EffectiveAlertEnabled;SdtStatus;DeviceStatus]
~~~ [String: value={orderby_forDeviceListmacro}] ~~~
[LogicMonitor.DeviceList: deviceGroups=/, recurseDeviceGroups=true, =>Devices, orderBy={orderby_forDeviceListmacro}][Json.List: jArray=`{Devices}`, jsonPath="$.[*].DisplayName", =>DeviceDisplayName] [ForEach: storeAs=displayname, values={DeviceDisplayName}, take=10]
    *** [String:value={displayname} ***] : [LogicMonitor.GraphSpecification: device={displayname}, graphName=CPU Usage, dataSourceInstanceName=WinCPU, =>GraphSpecification, failureText="No graph of this name on this device, please try again"]
[Object.Graph: graphSpec={=GraphSpecification}, pageWidthPercent=100, failureText="No graph"] [Unset: variable=GraphSpecification]
[EndForEach:][EndForEach:]

Compatibility

Usage

Examples (1)

Example 1

Search