ParameterQueryPropertiesInput is an input datatype for query properties.

This datatype is used by the datatype, ParameterInput datatype, which is used by two other datatypes: CreateDashboardInput, which is used by the createDashboard() mutation field; and UpdateDashboardInput, which is used by the updateDashboard() mutation.

Table: ParameterQueryPropertiesInput

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: Sep 19, 2024
invalidInputMessagestring  Long-TermThe message to use when query parameter is found invalid.
invalidInputPatterns[string]yes Long-TermThe patterns that are invalid.
queryStringstringyes Long-TermThe query string.
optionLabelFieldintegeryes Long-TermThe option label field.
optionValueFieldstringyes Long-TermThe option value field.
timeWindowstringyes Long-TermThe time window of events.
useDashboardTimeIfSetbooleanyes Long-TermWhether to use the dashboard time if set.