getExportDataByExportId()

Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > getExportDataByExportId

IWorkspaceDashboardsService.getExportDataByExportId() method

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

Get the metadata stored with the export identified by the provided export id: the inlined filter context together with other export-render inputs (title, widget-title visibility, custom metadata and the explicit timezone).

Signature:

getExportDataByExportId(exportId: string, type: "visual" | "slides" | undefined, tabId?: string): Promise<{
        filterContext?: IFilterContext;
        title?: string;
        hideWidgetTitles?: boolean;
        exportMetadata?: Record<string, string>;
        timezoneId?: string;
    } | null>;

Parameters

Parameter	Type	Description
exportId	string	export id
type	"visual" | "slides" | undefined	export type
tabId	string	(Optional) id of the tab to export

Returns:

Promise<{ filterContext?: IFilterContext; title?: string; hideWidgetTitles?: boolean; exportMetadata?: Record<string, string>; timezoneId?: string; } | null>

Remarks

The timezone is present only when it cannot be derived at export time (an ad-hoc view-mode override or a resolved browser-detected timezone); otherwise the dashboard's own stored timezone applies.