WidgetQueryPropertiesInput is an input datatype for the query properties of a widget.

This datatype is used by another datatype, WidgetInput, 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: WidgetQueryPropertiesInput

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 23, 2024
customLinkInteractions[CustomLinkInteractionInput]yes Long-TermThe factors for a custom link for interactions. See CustomLinkInteractionInput.
dashboardLinkInteractions[DashboardLinkInteractionInput]yes Long-TermThe factors for a dashboard link for the interactions. See DashboardLinkInteractionInput.
endstringyes Long-TermThe ending point for the widget query.
optionsstring  Long-TermAny options related to the widget.
queryStringstringyes Long-TermThe query string that is the basis for the widget.
searchLinkInteractions[SearchLinkInteractionInput]yes Long-TermThe factors for a search link for the interactions. See SearchLinkInteractionInput.
startstringyes Long-TermThe starting point for the widget query.
updateParametersInteractions[UpdateParametersInteractionInput]yes Long-TermThe settings to update for a parameters interaction. See UpdateParametersInteractionInput.
widgetTypestringyes Long-TermThe type of widget to use.