QueryBasedWidget is a datatype for a widget with a visualization of a query result. It implements the interface datatype, Widget.

Table: QueryBasedWidget

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
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: Mar 17, 2025 
descriptionstring  Long-Term A description of the widget.
endstringyes Long-Term The end point for events included in the widget's query.
heightintegeryes Long-Term The height of the widget.
idstringyes Long-Term The unique identifier of the widget.
interactions[QueryBasedWidgetInteraction]yes Long-Term The interactions of the query based widget. See QueryBasedWidgetInteraction.
isLivebooleanyes Long-Term Whether the query is performed on live, continuous data.
optionsJSON  Long-Term An optional JSON value containing styling and other settings for the widget. This is solely used by the UI. JSON is a scalar.
queryStringstringyes Long-Term The query for the widget.
startstringyes Long-Term The start point for events included in the widget's query.
titlestringyes Long-Term The title or heading of the widget.
widgetTypestringyes Long-Term The type of widget.
widthintegeryes Long-Term The width of the widget.
xintegeryes Long-Term The value of the X axis for the widget.
yintegeryes Long-Term The value of the Y axis for the widget.