QueryBasedDashboardParameter is a datatype for a dashboard parameter where suggestions are sourced from query results from LogScale.

Table: QueryBasedDashboardParameter

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 2, 2024
defaultMultiValues[string]yes The value assigned to the multi-value parameter on dashboard load, if no other value is specified. This replaces defaultValue whenever isMultiParamis true. This is a preview and subject to change.
defaultValueV2string  The value assigned to the parameter on dashboard load, if no other value is specified.
idstringyes The unique identifier of the parameter.
invalidInputMessagestring  Message when parameter input is blocked.
invalidInputPatterns[string]yes Regex patterns used to block parameter input.
isMultiParamboolean  Whether the parameter supports having multiple values.
labelstringyes The label or name displayed next to the input for the variable to make it more human-readable.
optionLabelFieldstringyes The field in the result set used as the label (i.e., the text in the dropdown) of the suggestions.
orderstring  A number that determines the order in which parameters are displayed on a dashboard. If null, the parameter is ordered alphanumerical after other parameters
queryStringstringyes The LogScale query executed to find suggestions for the parameter value.
optionValueFieldstringyes The field in the result set used as the value of the suggestions.
timeWindowstringyes The time window relative to now in which LogScale will search for suggestions (e.g., 24h or 30d).
useDashboardTimeIfSetbooleanyes If true, the parameters search time window will change to match the dashboard's global time when active.
widthinteger  The width of the parameter.