DashboardParameter is an interface datatype for a dashboard parameter.

This datatype is used by another datatype, Dashboard, which is used by many mutation and query fields.

As an interface, DashboardParameter is implemented by three datatypes: FileDashboardParameter; FixedListDashboardParameter; and QueryBasedDashboardParameter.

Table: DashboardParameter

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Jun 23, 2025
defaultValueV2string  Long-TermThe value assigned to the parameter on dashboard load, if no other value is specified.
idstringyes Long-TermThe unique identifier for the dashboard parameter.
labelstringyes Long-TermThe label or 'name' displayed next to the input for the variable to make it more human-readable.
orderinteger  Long-TermThe order in which parameters are displayed on a dashboard. If null, the parameter is ordered after other parameters in alphanumerical order.
widthinteger  Long-TermA number that determines the width of a parameter.