QueryBasedDashboardParameter
QueryBasedDashboardParameter
is a datatype for a dashboard parameter where suggestions are
sourced from query results from LogScale.
Table: QueryBasedDashboardParameter
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| 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: Mar 18, 2025 | |||||
defaultValueV2 | string | Long-Term | The value assigned to the parameter on dashboard load, if no other value is specified. | ||
id | string | yes | Long-Term | The unique identifier of the parameter. | |
invalidInputMessage | string | Long-Term | Message when parameter input is blocked. | ||
invalidInputPatterns | [string] | yes | Long-Term | Regex patterns used to block parameter input. | |
label | string | yes | Long-Term | The label or name displayed next to the input for the variable to make it more human-readable. | |
optionLabelField | string | yes | Long-Term | The field in the result set used as the label (i.e., the text in the dropdown) of the suggestions. | |
optionValueField | string | yes | Long-Term | The field in the result set used as the value of the suggestions. | |
order | integer | Long-Term | A number that determines the order in which parameters are displayed on a dashboard. If null, the parameter is ordered alphanumerical after other parameters | ||
queryString | string | yes | Long-Term | The LogScale query executed to find suggestions for the parameter value. | |
timeWindow | string | yes | Long-Term | The time window relative to now in which LogScale will search for suggestions (e.g., 24h or 30d). | |
useDashboardTimeIfSet | boolean | yes | Long-Term | If true, the parameters search time window will change to match the dashboard's global time when active. | |
width | integer | Long-Term | The width of the parameter. | ||