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 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: 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.