IDashboardSummaryRequest
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Request payload for AI dashboard summarization.
export interface IDashboardSummaryRequest
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (BETA) | ||
FilterContextItem[] | null | (BETA) (Optional) Filter context to apply when generating the summary. | ||
string | null | (BETA) (Optional) Hint describing the desired output format of the generated summary. Use it as an additional prompt. | ||
string | null | (BETA) (Optional) Identifier of the dashboard tab to summarize. Omit to summarize the whole dashboard. | ||
string[] | null | (BETA) (Optional) Visualizations to include in the summary. |
Property details
IDashboardSummaryRequest.dashboardIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
dashboardId: string;
IDashboardSummaryRequest.filterContextpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Filter context to apply when generating the summary. null means use all dashboard filters. Omit to let the backend decide.
filterContext?: FilterContextItem[] | null;
IDashboardSummaryRequest.formatHintpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Hint describing the desired output format of the generated summary. Use it as an additional prompt.
formatHint?: string | null;
IDashboardSummaryRequest.tabIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Identifier of the dashboard tab to summarize. Omit to summarize the whole dashboard.
tabId?: string | null;
IDashboardSummaryRequest.visualizationspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Visualizations to include in the summary. null means include all visualizations on the dashboard. Omit to let the backend decide.
visualizations?: string[] | null;