QueryBasedDashboardParameter is a datatype for a dashboard parameter where suggestions are sourced from query results from LogScale. It implements the interface datatype, DashboardParameter.

Table: QueryBasedDashboardParameter

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Mar 18, 2025
defaultValueV2string  Long-TermThe value assigned to the parameter on dashboard load, if no other value is specified.
idstringyes Long-TermThe unique identifier of the parameter.
invalidInputMessagestring  Long-TermMessage when parameter input is blocked.
invalidInputPatterns[string]yes Long-TermRegex patterns used to block parameter input.
labelstringyes Long-TermThe label or name displayed next to the input for the variable to make it more human-readable.
optionLabelFieldstringyes Long-TermThe field in the result set used as the label (i.e., the text in the dropdown) of the suggestions.
optionValueFieldstringyes Long-TermThe field in the result set used as the value of the suggestions.
orderinteger  Long-TermA number that determines the order in which parameters are displayed on a dashboard. If null, the parameter is ordered alphanumerical after other parameters
queryStringstringyes Long-TermThe LogScale query executed to find suggestions for the parameter value.
timeWindowstringyes Long-TermThe time window relative to now in which LogScale will search for suggestions (e.g., 24h or 30d).
useDashboardTimeIfSetbooleanyes Long-TermIf true, the parameters search time window will change to match the dashboard's global time when active.
widthinteger  Long-TermThe width of the parameter.