IDashboardSummaryRequest

Home > @gooddata/sdk-backend-spi > IDashboardSummaryRequest

IDashboardSummaryRequest interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Request payload for AI dashboard summarization.

Signature:

export interface IDashboardSummaryRequest

Properties

Property

Modifiers

Type

Description

dashboardId

string

(BETA)

filterContext?

FilterContextItem[] | null

(BETA) (Optional) Filter context to apply when generating the summary. null means use all dashboard filters. Omit to let the backend decide.

formatHint?

string | null

(BETA) (Optional) Hint describing the desired output format of the generated summary. Use it as an additional prompt.

tabId?

string | null

(BETA) (Optional) Identifier of the dashboard tab to summarize. Omit to summarize the whole dashboard.

visualizations?

string[] | null

(BETA) (Optional) Visualizations to include in the summary. null means include all visualizations on the dashboard. Omit to let the backend decide.

← IDashboardSummaryIncludedVisualizationIDashboardWithReferences →