Dashboard Widget Input

This page describes the DashboardWidgetInput object used for creating and updating dashboard widgets.

DashboardWidgetInput

id · String

Optional widget ID for update operations. Omit for creation.

domainId · String

Optional domain ID associated with the widget.

title · String

Optional display title. If null, the natural language query will be used as title.

nlQuery · String

Natural language query for generating the widget content.

visualizationId · String

Optional ID of an existing visualization to use for the widget.

visualizationType · VisualizationType

Optional visualization type. If null, will be determined from the natural language query. See VisualizationType.

layout · WidgetLayoutInput

Positioning and sizing information for the widget. See WidgetLayoutInput.

sourceConversationId · String

Optional ID of the conversation that generated this widget.

sourceMessageId · String

Optional ID of the message that generated this widget.

dataRefreshedAt · DateTime

Optional timestamp for when data was last refreshed.

body · UpdateChatMessageBodyOneOf

Optional message body for chat-based widget updates.

widgetType · WidgetType

Type of widget content. See WidgetType.

markdownContent · String

Markdown content for text/markdown widgets.

Additional Resources

DashboardWidget Object

Resulting widget structure

Create Dashboard

Mutation using DashboardWidgetInput

Update Dashboard Widgets

Update mutation using DashboardWidgetInput