Dashboard Widget

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

DashboardWidget

id · ID! · required

Unique identifier for the widget.

domain · ZSheet

Domain associated with this widget. May be null if the domain was deleted after widget creation.

title · String! · required

Display title for the widget.

nlQuery · String! · required

Natural language query that generated this widget’s content.

visualization · Visualization

Chart or table visualization data. Null if there was an error generating the visualization. See Visualization.

visualizationType · VisualizationType

Type of visualization (chart, table, etc.). See VisualizationType.

layout · WidgetLayout! · required

Positioning and sizing information for the widget. See WidgetLayout.

dataRefreshedAt · DateTime! · required

Timestamp when the widget data was last refreshed.

conversationId · String

ID of the conversation that generated this widget. Null if not sourced from a conversation.

messageId · String

ID of the message that generated this widget. Null if not sourced from a conversation.

userCanAskFollowUp · Boolean! · required

Whether the current user can ask follow-up questions about this widget.

userCanViewOriginalMessage · Boolean! · required

Whether the current user can view the original conversation message that generated this widget.

widgetType · WidgetType! · required

Type of widget content. See WidgetType.

markdownContent · String

Markdown content for text/markdown widgets.

WidgetType

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

Value	Description
WIDGET_TYPE_UNKNOWN	Unknown widget type
WIDGET_TYPE_VISUALIZATION	Chart or table visualization
WIDGET_TYPE_MARKDOWN	Rich text content
WIDGET_TYPE_SUMMARY	Summary or aggregated content

Additional Resources

Dashboard Object

Parent dashboard structure

WidgetLayout Object

Widget positioning and sizing

Visualization Object

Chart and table data structure

Update Dashboard Widgets

Modify widget properties