getDashboard()

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

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

Load dashboard by its reference, and override filter context with the given custom filter context (custom filter context is used mainly for exporting)

Signature:

getDashboard(ref: ObjRef, filterContextRef?: ObjRef, options?: IGetDashboardOptions): Promise<IDashboard>;

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

Returns:

Promise<IDashboard>

promise of the dashboard