FreeTextDashboardParameter is a datatype for a dashboard parameter without restrictions or suggestions. It implements the interface datatype, DashboardParameter.

Table: FreeTextDashboardParameter

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: Jan 7, 2026
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-TermA message returned when parameter input is blocked.
invalidInputPatterns[string]  Long-TermThe regex 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.
orderinteger  Long-TermA number that determines the order in which parameters are displayed on a dashboard. If null, the parameter is ordered after other parameters in alphanumerical order.
widthinteger  Long-TermThe width of a parameter.