Inserts a Netflow summary table for a Netflow-enabled Device or Device Group. Valid types are: 'Flows', 'Interfaces', 'Applications', 'Endpoints' or 'Bandwidths'. Each type results in a different table, similar to those be displayed on the 'Traffic' tab in LogicMonitor for Devices or Device Groups that are Netflow-enabled. Note: 1KB = 1,000 bytes, 1MB = 1,000 KB bytes and 1GB = 1,000 MB).
Compatibility
The macro can be used in the highlighted input document types only. A greyed-out icon indicates not supported.
Updates
v4.620 days ago · September 2026
The help now lists every column you can ask for and what each one holds, so you no longer have to know the column names in advance. The columns parameter's description was showing the text meant for its default value, so it now describes the parameter and the default explains that the columns vary with the type parameter. The columns parameter is also now shown under Output rather than General.
History (2)
v4.6One month ago · September 2026
The 'style' parameter now applies Word's own built-in style for the Grid Table 5 Dark, Grid Table 6 Colorful and Grid Table 7 Colorful families (and their Accent variants), rather than a look-alike custom style named 'Grid Table 5', 'Grid Table 6' or 'Grid Table 7'. Using one of these styles for several tables no longer leaves extra styles such as 'Grid Table 51' in the Word document. Applies to every table-producing macro.
v4.43 months ago · June 2026
The 'repeatHeaderPerPage' parameter now works as expected (now honours the false setting).
Parameters(68)
Mandatory(1)
Parameter
Type
Purpose
Options
Default
type
TrafficTableType
The table type. Flows corresponds to Top Flows table. Applications corresponds to Top Talkers table. Endpoints corresponds to Top Destination Endpoints table. Interfaces corresponds to the Interfaces table. Note that when the device / deviceId parameter is used, Devices do not support 'Bandwidths. When the deviceGroup parameter is used, only Flows, Applications and Bandwidths are supported.
Flows
Interfaces
Applications
Endpoints
Bandwidths
N/A
Behaviour(2)10 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 (10)
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
desiredExecutionResult
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'.
Cancelled
Deferred
MacroError
NeverRun
Paused
Pending
Running
Stopped
Success
SystemError
Warning
WorkerStopped
N/A
errorOnOverflow
Boolean
Optional
Should NCalc expression evaluation throw error on Overflow
true
false
true
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
hidden
Boolean
Optional
If true, the table will not be written to the report. This is useful if you want to use a Table macro in PowerPoint or RM Script files (which do not support adding tables) but have XLSX output enabled on the Schedule. This way the table data will be preserved and the macro will produce a Success rather than Macro Error, and the XLSX table will be generated. Note that in RM Script or Report Studio (code mode), you must set the hidden parameter to true or a Macro Error will occur.
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
mode
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
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
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(13)
Parameter
Type
Presence
Purpose
Options
Default
criticalCellColor
Color
Optional
The critical cell background color to use. If omitted, the default of #C00000 is used; set it explicitly to override. Affects a cell or row based on the ThresholdAffects parameter.
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 [A=255, R=192, G=0, B=0]
criticalCellTextColor
Color
Optional
The critical cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
errorCellColor
Color
Optional
The error cell background color to use. If omitted, the default of #F08000 is used; set it explicitly to override. Affects a cell or row based on the ThresholdAffects parameter.
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 [A=255, R=240, G=128, B=0]
errorCellTextColor
Color
Optional
The error cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
fatalCellColor
Color
Optional
The fatal cell background color to use. If omitted, the default of #960000 is used; set it explicitly to override. Affects a cell or row based on the ThresholdAffects parameter.
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 [A=255, R=150, G=0, B=0]
fatalCellTextColor
Color
Optional
The fatal cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
infoCellColor
Color
Optional
The info cell background color to use. If omitted, the default of #00D5D5 is used; set it explicitly to override. Affects a cell or row based on the ThresholdAffects parameter.
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 [A=255, R=0, G=213, B=213]
infoCellTextColor
Color
Optional
The info cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
normalCellColor
Color
Optional
The cell color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter.
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
normalCellTextColor
Color
Optional
The cell text color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter.
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
warningCellColor
Color
Optional
The warning cell background color to use. If omitted, the default of #F0C000 is used; set it explicitly to override. Affects a cell or row based on the ThresholdAffects parameter.
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 [A=255, R=240, G=192, B=0]
warningCellTextColor
Color
Optional
The warning cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
worksheetTabColor
Color
Optional
The colour of the worksheet tab in Excel (XLSX) output. If omitted, the tab keeps its default colour. Has no effect on Word / PDF / HTML output, which have no worksheet tabs.
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(1)10 additional
Parameter
Type
Presence
Purpose
Options
Default
flowDirection
FlowDirection
Optional
The flow direction.
All
In
Out
All
Additional (10)
Parameter
Type
Presence
Purpose
Options
Default
autoFit
AutoFitBehavior
Optional
The Word autofit behaviour. If omitted, no change is made.
Content
Fixed
Window
Content
columnHorizontalAlignments
List<String>
Optional
The column horizontal alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnHorizontalAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI.
N/A
N/A
columnVerticalAlignments
List<String>
Optional
The column vertical alignments. If fewer alignments are given than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Top, Centre and Bottom. Usage: columnVerticalAlignments=Top;Centre;Bottom;... Applies to Word, Report Studio and Excel output.
N/A
N/A
fontSize
Double
Optional
Override the table style's font size. This is achieved by setting the font size for each table cell. In Report Studio and HTML this is in pixels; in a Schedule (Word) it is in points.
From 4 to 50
N/A
format
CellFormat
Optional
The cell format to use. Options are: 'AllStrings', 'Auto' or 'NumbersAsStrings'. Auto automatically sets the format for the whole column, or it can be forced to a string with AllStrings. To preserve date / time formatting (with dateTimeFormat) but treat only number columns as strings, use NumbersAsStrings.
Auto
AllStrings
NumbersAsStrings
Auto
horizontalAlignment
TableHorizontalAlignment
Optional
The horizontal alignment of the table on the page (does not affect Excel output).
Left
Center
Right
Left
pageWidthPercent
Double
Optional
The percentage of the available page that the table should occupy.
From 0 to 150
N/A
repeatHeaderPerPage
Boolean
Optional
Whether to repeat the header row at the beginning of each page.
true
false
true
style
String
Optional
Use Word's built in Table Styles (such as Grid Table 2 - Accent 1), or make your own in the Report Template. Built-in styles can be used in any document. Note that any custom styles you create, or customisations to the standard styles required that the styles exist in the input template XML (because they are not saved in Word documents by default). This can be achieved by assigning the style to a table, then delete the table and save the document.
N/A
Table Grid
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
Time & Date(4)
Parameter
Type
Presence
Purpose
Options
Default
dateTimeFormat
String
Optional
The date/time format to use. Use the format specified here: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings. When the format parameter is set to AllStrings, this is ignored unless you use NumbersAsStrings. Note however that this parameter only has an effect if all the values in the column are the same type.
N/A
yyyy-MM-dd
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(4)
Parameter
Type
Presence
Purpose
Options
Default
includeCondition
String
Optional
The condition on which each row is included. Fields should be referred to based on the column name in curly braces, for example: includeCondition ='{CreatedOn}'>'{StartOfLastMonth}'.
N/A
N/A
orderBy
String
Optional
If present, sorts alphanumerically by this column.
N/A
N/A
orderByDescending
String
Optional
If present, sorts reverse alphanumerically by this column.
N/A
N/A
take
Int32
Optional
Only display up to this number of rows.
From 0 to 2147483647
N/A
Output(1)5 additional
Parameter
Type
Presence
Purpose
Options
Default
columns
List<String>
Optional
The columns to use in the table in order left to right, semicolon-separated.
ClientCount - The number of clients
DestinationBytes - Destination traffic in bytes
DestinationDns - Destination DNS entry
DestinationGigabytes - Destination traffic in GB
DestinationIp - Destination IP address
DestinationKilobytes - Destination traffic in KB
DestinationMegabytes - Destination traffic in MB
DestinationPort - Destination port
DestinationVolume - Destination traffic (Auto-indicates bytes, KB, MB or GB based on usage)
Dns - DNS (Used when type is set to Endpoints)
FirstSeen - FirstSeen (Used when type is set to Endpoints)
FlowCount - The number of flows
InboundInterface - Inbound interface name
InboundInterfaceId - Inbound interface Id
InterfaceIndex - InterfaceIndex (Used when type is set to Interfaces)
InterfaceName - Interface name (normally blank unless otherwise configured in LogicMonitor
Ip - IP Address (Used when type is set to Endpoints)
LastDataDateTimeUtc - LastDataDateTimeUtc (Used when type is set to Interfaces)
LastSeen - LastSeen (Used when type is set to Endpoints)
OutboundInterface - Outbound interface name
OutboundInterfaceId - Outbound interface Id
PercentUsage - Percentage usage
Protocol - The Protocol
SourceBytes - Source bytes
SourceDns - Source DNS entry
SourceGigabytes - Source traffic in GB
SourceIp - Source IP Address
SourceKilobytes - Source traffic in KB
SourceMegabytes - Source traffic in MB
SourcePort - Source port
SourceVolume - Source traffic (Auto-indicates bytes, KB, MB or GB based on usage)
Type - Type (Used when type is set to Endpoints)
UsageBytes - Usage bytes
UsageGigabytes - Total traffic in GB
UsageKilobytes - Total traffic in KB
UsageMegabytes - Total traffic in MB
UsageVolume - Total traffic (Auto-indicates bytes, KB, MB or GB based on usage)
Variable, based on the type parameter.
Additional (5)
Parameter
Type
Presence
Purpose
Options
Default
emptyTableText
String
Optional
If present, and the table has no rows, the specified text will be inserted in place of the table.
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
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
writeToSpreadsheet
Boolean
Optional
Whether to output the result in the output Excel document (if so configured).
true
false
true
General(4)6 additional
Parameter
Type
Presence
Purpose
Options
Default
type
TrafficTableType
Mandatory
The table type. Flows corresponds to Top Flows table. Applications corresponds to Top Talkers table. Endpoints corresponds to Top Destination Endpoints table. Interfaces corresponds to the Interfaces table. Note that when the device / deviceId parameter is used, Devices do not support 'Bandwidths. When the deviceGroup parameter is used, only Flows, Applications and Bandwidths are supported.
Flows
Interfaces
Applications
Endpoints
Bandwidths
N/A
device
String
Conditional
The Device's display name. If not present, 'deviceId' must be.
N/A
N/A
deviceId
Int32
Conditional
The Device's ID. If not present, 'device' must be.
N/A
N/A
deviceGroups
List<String>
Optional
The Device Group(s). Use "/" or no value in the 'deviceGroups' parameter to reference the root folder. When using multiple Device Groups, separate each item by a semi-colon such as 'deviceGroups=group1;group2'. It is advisable to use the 'orderBy' parameter to order by a specific column (e.g. 'orderBy=DestinationBytes') when multiple Device Groups are specified, otherwise the data may not be ordered correctly.
N/A
N/A
Additional (6)
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
deCamelCaseHeaderRow
Boolean
Optional
Whether to de-camel-case the header row (i.e. convert 'MyHeaderText' to 'My Header Text'.
true
false
false
tableName
String
Optional
The table name (e.g. for XLSX output)
N/A
Table
thresholdAffects
ThresholdAffects
Optional
What the threshold affects.
Cell
Row
Cell
thresholdColumn
String
Optional
The threshold column.
N/A
N/A
Deprecated(3)5 additional
Parameter
Type
Preferred Parameter
Purpose
Options
Default
deviceGroup
List<String>
deviceGroups
The Device Group(s). Use "/" or no value in the 'deviceGroups' parameter to reference the root folder. When using multiple Device Groups, separate each item by a semi-colon such as 'deviceGroups=group1;group2'. It is advisable to use the 'orderBy' parameter to order by a specific column (e.g. 'orderBy=DestinationBytes') when multiple Device Groups are specified, otherwise the data may not be ordered correctly.
N/A
N/A
group
List<String>
deviceGroups
The Device Group(s). Use "/" or no value in the 'deviceGroups' parameter to reference the root folder. When using multiple Device Groups, separate each item by a semi-colon such as 'deviceGroups=group1;group2'. It is advisable to use the 'orderBy' parameter to order by a specific column (e.g. 'orderBy=DestinationBytes') when multiple Device Groups are specified, otherwise the data may not be ordered correctly.
N/A
N/A
groups
List<String>
deviceGroups
The Device Group(s). Use "/" or no value in the 'deviceGroups' parameter to reference the root folder. When using multiple Device Groups, separate each item by a semi-colon such as 'deviceGroups=group1;group2'. It is advisable to use the 'orderBy' parameter to order by a specific column (e.g. 'orderBy=DestinationBytes') when multiple Device Groups are specified, otherwise the data may not be ordered correctly.
N/A
N/A
Additional (5)
Parameter
Type
Preferred Parameter
Purpose
Options
Default
alignment
List<String>
columnHorizontalAlignments
The column horizontal alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnHorizontalAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI.
N/A
N/A
alignments
List<String>
columnHorizontalAlignments
The column horizontal alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnHorizontalAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI.
N/A
N/A
autofit
AutoFitBehavior
autoFit
The Word autofit behaviour. If omitted, no change is made.
Content
Fixed
Window
Content
columnAlignments
List<String>
columnHorizontalAlignments
The column horizontal alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnHorizontalAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI.
