QueryBasedWidget is a datatype for a widget with a visualization of a query result.

Table: QueryBasedWidget

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