getDashboardWithReferences()

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

IWorkspaceDashboardsService.getDashboardWithReferences() 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.

Loads a dashboard and objects that the dashboard references.

Signature:

getDashboardWithReferences(ref: ObjRef, filterContextRef?: ObjRef, options?: IGetDashboardOptions, types?: SupportedDashboardReferenceTypes[]): Promise<IDashboardWithReferences>;

Parameters

Parameter	Type	Description
ref	ObjRef	dashboard ref
filterContextRef	ObjRef	(Optional) Override dashboard filter context with the custom filter context (This allows to modify filter context when exporting the dashboard)
options	IGetDashboardOptions	(Optional) Specify additional options
types	SupportedDashboardReferenceTypes[]	(Optional) types of dashboard references to load; if the types are undefined, the service must default to loading insights related to the dashboard

Returns:

Promise<IDashboardWithReferences>

promise of the dashboard and references