DashboardParameter
represents a dashboard parameter.
Table: DashboardParameter
| 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: Sep 17, 2024 | |||||
defaultMultiValues | [string] | yes | Long-Term | The value assigned to the multi-value parameter on dashboard load, if no other value is specified. This replaces defaultValue whenever isMultiParam is true. | |
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 for the dashboard parameter. | |
isMultiParam | boolean | yes | Long-Term | A flag indicating whether the parameter supports having multiple values. | |
label | string | yes | Long-Term | The label or 'name' displayed next to the input for the variable to make it more human-readable. | |
order | integer | Long-Term | The order in which parameters are displayed on a dashboard. If null, the parameter is ordered after other parameters in alphanumerical order. | ||
width | integer | Long-Term | A number that determines the width of a parameter. | ||