Skip to main content
This page describes the DashboardWidget object that represents individual visualizations and content blocks within a dashboard.

DashboardWidget

ID!
required
Unique identifier for the widget.
ZSheet
Domain associated with this widget. May be null if the domain was deleted after widget creation.
String!
required
Display title for the widget.
String!
required
Natural language query that generated this widget’s content.
Visualization
Chart or table visualization data. Null if there was an error generating the visualization. See Visualization.
VisualizationType
Type of visualization (chart, table, etc.). See VisualizationType.
WidgetLayout!
required
Positioning and sizing information for the widget. See WidgetLayout.
DateTime!
required
Timestamp when the widget data was last refreshed.
String
ID of the conversation that generated this widget. Null if not sourced from a conversation.
String
ID of the message that generated this widget. Null if not sourced from a conversation.
Boolean!
required
Whether the current user can ask follow-up questions about this widget.
Boolean!
required
Whether the current user can view the original conversation message that generated this widget.
WidgetType!
required
Type of widget content. See WidgetType.
String
Markdown content for text/markdown widgets.

WidgetType

The type of content displayed in the widget. The possible values are:

Dashboard Object

Parent dashboard structure

WidgetLayout Object

Widget positioning and sizing

Visualization Object

Chart and table data structure

Update Dashboard Widgets

Modify widget properties