IWorkspaceDashboardsService

IWorkspaceDashboardsService.workspacepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

readonly workspace: string;

IWorkspaceDashboardsService.createDashboard()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Create and save dashboard for the provided dashboard definition

createDashboard(dashboard: IDashboardDefinition, generateId?: boolean): Promise<IDashboard>;

Parameters

Returns

Promise<IDashboard>

promise of the created dashboard

IWorkspaceDashboardsService.createDashboardPlugin()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Creates a record about a dashboard plugin. Creating a new dashboard plugin does not impact any existing dashboards in the workspace.

In order to use a plugin on a dashboard, you need to create a link between the dashboard and the plugin. Multiple dashboards may link to a single plugin; each dashboard may link to the plugin with different plugin-specific parameters.

createDashboardPlugin(plugin: IDashboardPluginDefinition): Promise<IDashboardPlugin>;

Parameters

Returns

Promise<IDashboardPlugin>

Remarks

Analytical Backend only allows creating new dashboard plugins or deleting existing plugins. The goal behind this decision is to encourage safe, phased rollout of new plugin versions. You must first create a new dashboard plugin and then explicitly start using this new version on dashboards in order for changes to take effect.

IWorkspaceDashboardsService.createFilterView()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Create a new filter view.

createFilterView(filterView: IDashboardFilterViewSaveRequest): Promise<IDashboardFilterView>;

Parameters

Returns

Promise<IDashboardFilterView>

IWorkspaceDashboardsService.createScheduledMail()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Create scheduled mail for the dashboard

createScheduledMail(scheduledMail: IScheduledMailDefinition, exportFilterContext?: IFilterContextDefinition): Promise<IScheduledMail>;

Parameters

Returns

Promise<IScheduledMail>

promise of the created scheduled email

IWorkspaceDashboardsService.createWidgetAlert()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Create widget alert for the provided widget alert definition

createWidgetAlert(alert: IWidgetAlertDefinition): Promise<IWidgetAlert>;

Parameters

Returns

Promise<IWidgetAlert>

promise with the created alert

IWorkspaceDashboardsService.deleteDashboard()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete dashboard

deleteDashboard(ref: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

promise

IWorkspaceDashboardsService.deleteDashboardPlugin()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Deletes a record about a dashboard plugin from the backend.

deleteDashboardPlugin(ref: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

Remarks

• some backend implementations may reject to delete a dashboard plugin that is used on existing dashboards

IWorkspaceDashboardsService.deleteFilterView()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete a filter view identified by the provided ref.

deleteFilterView(ref: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

IWorkspaceDashboardsService.deleteScheduledMail()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete scheduled mail

deleteScheduledMail(ref: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

promise

IWorkspaceDashboardsService.deleteWidgetAlert()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete widget alert with the given reference

deleteWidgetAlert(ref: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

promise

IWorkspaceDashboardsService.deleteWidgetAlerts()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Widget alerts bulk delete

deleteWidgetAlerts(refs: ObjRef[]): Promise<void>;

Parameters

Returns

Promise<void>

promise

IWorkspaceDashboardsService.exportDashboardToCSVRaw()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Export dashboard to CSV raw.

CSV raw file is downloaded and attached as Blob data to the current window instance.

exportDashboardToCSVRaw(definition: IExecutionDefinition, fileName: string, customOverrides?: IRawExportCustomOverrides, options?: IDashboardExportRawOptions): Promise<IExportResult>;

Parameters

Returns

Promise<IExportResult>

promise with object URL pointing to a Blob data of downloaded exported dashboard

IWorkspaceDashboardsService.exportDashboardToImage()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Export dashboard to png.

PNG file is downloaded and attached as Blob data to the current window instance. If title is not provided, the dashboard title will be fetched.

exportDashboardToImage(ref: ObjRef, filters?: FilterContextItem[], filtersByTab?: FiltersByTab, options?: IDashboardExportImageOptions): Promise<IExportResult>;

Parameters

Returns

Promise<IExportResult>

promise with object URL pointing to a Blob data of downloaded exported dashboard

IWorkspaceDashboardsService.exportDashboardToPdf()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Export dashboard to pdf. You can override dashboard filters with custom filters. When no custom filters are set, the persisted dashboard filters will be used.

PDF file is downloaded and attached as Blob data to the current window instance.

exportDashboardToPdf(ref: ObjRef, filters?: FilterContextItem[], filtersByTab?: FiltersByTab, options?: IDashboardExportPdfOptions): Promise<IExportResult>;

Parameters

Returns

Promise<IExportResult>

promise with object URL pointing to a Blob data of downloaded exported dashboard

IWorkspaceDashboardsService.exportDashboardToPresentation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Export dashboard to pdf. You can override dashboard filters with custom filters. When no custom filters are set, the persisted dashboard filters will be used.

PDF file is downloaded and attached as Blob data to the current window instance.

exportDashboardToPresentation(ref: ObjRef, format: "PDF" | "PPTX", filters?: FilterContextItem[], filtersByTab?: FiltersByTab, options?: IDashboardExportPresentationOptions): Promise<IExportResult>;

Parameters

Returns

Promise<IExportResult>

promise with object URL pointing to a Blob data of downloaded exported dashboard

IWorkspaceDashboardsService.exportDashboardToTabular()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Export dashboard to tabular.

Tabular file is downloaded and attached as Blob data to the current window instance. If title is not provided, the dashboard title will be fetched.

exportDashboardToTabular(ref: ObjRef, options?: IDashboardExportTabularOptions): Promise<IExportResult>;

Parameters

Returns

Promise<IExportResult>

promise with object URL pointing to a Blob data of downloaded exported dashboard

IWorkspaceDashboardsService.getAllWidgetAlertsForCurrentUser()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get all widget alerts for the current user

getAllWidgetAlertsForCurrentUser(): Promise<IWidgetAlert[]>;

Returns

Promise<IWidgetAlert[]>

promise with all user widget alerts

IWorkspaceDashboardsService.getDashboard()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

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

Parameters

Returns

Promise<IDashboard>

promise of the dashboard

IWorkspaceDashboardsService.getDashboardPermissions()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get current user’s permissions to the dashboard.

getDashboardPermissions(ref: ObjRef): Promise<IDashboardPermissions>;

Parameters

Returns

Promise<IDashboardPermissions>

IWorkspaceDashboardsService.getDashboardPlugin()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Load dashboard plugin by it’s reference.

getDashboardPlugin(ref: ObjRef, options?: IGetDashboardPluginOptions): Promise<IDashboardPlugin>;

Parameters

Returns

Promise<IDashboardPlugin>

IWorkspaceDashboardsService.getDashboardPlugins()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Gets all dashboard plugins registered in the current workspace.

getDashboardPlugins(options?: IGetDashboardPluginOptions): Promise<IDashboardPlugin[]>;

Parameters

Returns

Promise<IDashboardPlugin[]>

IWorkspaceDashboardsService.getDashboardReferencedObjects()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get objects referenced by a given dashboard.

getDashboardReferencedObjects(dashboard: IDashboard, types?: SupportedDashboardReferenceTypes[]): Promise<IDashboardReferences>;

Parameters

Returns

Promise<IDashboardReferences>

IWorkspaceDashboardsService.getDashboards()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Gets all dashboards available in current workspace.

getDashboards(options?: IGetDashboardOptions): Promise<IListedDashboard[]>;

Parameters

Returns

Promise<IListedDashboard[]>

promise of list of the dashboards

IWorkspaceDashboardsService.getDashboardsQuery()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

List dashboards

getDashboardsQuery(): IDashboardsQuery;

Returns

IDashboardsQuery

methods for querying dashboards

IWorkspaceDashboardsService.getDashboardSummaryWorkflowStatus()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Gets the status of the dashboard summary workflow. Used for polling the status of the workflow run.

getDashboardSummaryWorkflowStatus?(runId: string): Promise<IDashboardSummaryWorkflowStatusResult>;

Parameters

Returns

Promise<IDashboardSummaryWorkflowStatusResult>

IWorkspaceDashboardsService.getDashboardWidgetAlertsForCurrentUser()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get all widget alerts for the current user for the given dashboard

getDashboardWidgetAlertsForCurrentUser(ref: ObjRef): Promise<IWidgetAlert[]>;

Parameters

Returns

Promise<IWidgetAlert[]>

promise with all user widget alerts for the dashboard

IWorkspaceDashboardsService.getDashboardWithReferences()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Loads a dashboard and objects that the dashboard references.

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

Parameters

Returns

Promise<IDashboardWithReferences>

promise of the dashboard and references

IWorkspaceDashboardsService.getExportDataByExportId()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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).

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

Parameters

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.

IWorkspaceDashboardsService.getFilterViewsForCurrentUser()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get a list of filter views for the current user.

getFilterViewsForCurrentUser(dashboardRef: ObjRef): Promise<IDashboardFilterView[]>;

Parameters

Returns

Promise<IDashboardFilterView[]>

IWorkspaceDashboardsService.getResolvedFiltersForWidget()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Takes a widget and a list of filters and returns filters that can be used for the widget. - for attribute filters, these are filters that should NOT be ignored according to the ignoreDashboardFilters property. - for date filters it is the last filter with the same date dimension as specified in dateDataSet property. DOES NOT SUPPORT MULTIPLE DATE FILTERS. If you want to provide multiple date filters, pls refer to getResolvedFiltersForWidgetWithMultipleDateFilters

The implementation MUST take different ObjRef types into account, for example if an incoming filter uses idRef and an ignoreDashboardFilters item uses uriRef but they point to the same metadata object, the filter MUST NOT be included in the result.

getResolvedFiltersForWidget(widget: IWidget, filters: IFilter[], attributeFilterConfigs: IDashboardAttributeFilterConfig[]): Promise<IFilter[]>;

Parameters

Returns

Promise<IFilter[]>

promise with the filters with the ignored filters removed

IWorkspaceDashboardsService.getResolvedFiltersForWidgetWithMultipleDateFilters()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Takes a widget, commonDateFilters and a list of other filters and returns filters that can be used for the widget. - common date filters are used only when match widget’s date data set. If multiple of them match the last one is used - other date filters - these are filters that should NOT be ignored according to the ignoreDashboardFilters property. May have date data sets different from one in widget’s definition - for attribute filters - these are filters that should NOT be ignored according to the ignoreDashboardFilters property.

The implementation MUST take different ObjRef types into account, for example if an incoming filter uses idRef and an ignoreDashboardFilters item uses uriRef but they point to the same metadata object, the filter MUST NOT be included in the result.

getResolvedFiltersForWidgetWithMultipleDateFilters(widget: IWidget, commonDateFilters: IDateFilter[], otherFilters: IFilter[], attributeFilterConfigs: IDashboardAttributeFilterConfig[]): Promise<IFilter[]>;

Parameters

Returns

Promise<IFilter[]>

promise with the filters with the ignored filters removed

IWorkspaceDashboardsService.getScheduledMailsCountForDashboard()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get the number of scheduled emails for particular dashboard

getScheduledMailsCountForDashboard(ref: ObjRef): Promise<number>;

Parameters

Returns

Promise<number>

promise with the number of scheduled emails connected to the dashboard

IWorkspaceDashboardsService.getScheduledMailsForDashboard()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get scheduled emails for particular dashboard

getScheduledMailsForDashboard(ref: ObjRef, options?: IGetScheduledMailOptions): Promise<IScheduledMail[]>;

Parameters

Returns

Promise<IScheduledMail[]>

promise with scheduled emails connected to the dashboard

IWorkspaceDashboardsService.getWidgetAlertsCountForWidgets()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get the number of widget alerts (created by any user) for particular widgets

getWidgetAlertsCountForWidgets(refs: ObjRef[]): Promise<IWidgetAlertCount[]>;

Parameters

Returns

Promise<IWidgetAlertCount[]>

promise with array of pairs of widget ref and alert count

IWorkspaceDashboardsService.getWidgetReferencedObjects()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get all metadata objects referenced by a given widget.

getWidgetReferencedObjects(widget: IWidget, types?: SupportedWidgetReferenceTypes[]): Promise<IWidgetReferences>;

Parameters

Returns

Promise<IWidgetReferences>

IWorkspaceDashboardsService.setCertification()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Sets dashboard certification metadata.

setCertification(ref: ObjRef, certification?: IObjectCertificationWrite): Promise<void>;

Parameters

Returns

Promise<void>

IWorkspaceDashboardsService.setFilterViewAsDefault()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Set a filter view identified by the provided ref as the default one. The other filter views for the same dashboard that are marked as default ones will be unmarked.

setFilterViewAsDefault(ref: ObjRef, isDefault: boolean): Promise<void>;

Parameters

Returns

Promise<void>

IWorkspaceDashboardsService.startDashboardSummaryWorkflow()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Starts the process of generating AI summary for the dashboard.

startDashboardSummaryWorkflow?(dashboardId: string): Promise<IDashboardSummaryWorkflowStartResult>;

Parameters

Returns

Promise<IDashboardSummaryWorkflowStartResult>

IWorkspaceDashboardsService.updateDashboard()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Update dashboard

updateDashboard(dashboard: IDashboard, updatedDashboard: IDashboardDefinition): Promise<IDashboard>;

Parameters

Returns

Promise<IDashboard>

promise of the updated dashboard

IWorkspaceDashboardsService.updateDashboardMeta()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Patch dashboard

updateDashboardMeta(updatedDashboard: IDashboardObjectIdentity & Partial<IDashboardBase>): Promise<IDashboard>;

Parameters

Returns

Promise<IDashboard>

promise of the updated dashboard

IWorkspaceDashboardsService.updateScheduledMail()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Update existing scheduled mail for the dashboard

updateScheduledMail(ref: ObjRef, scheduledMail: IScheduledMailDefinition, filterContextRef?: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

promise of the updated scheduled email

IWorkspaceDashboardsService.updateWidgetAlert()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Update widget alert

updateWidgetAlert(alert: IWidgetAlert | IWidgetAlertDefinition): Promise<IWidgetAlert>;

Parameters

Returns

Promise<IWidgetAlert>

promise with the updated alert

IWorkspaceDashboardsService.validateDashboardsExistence()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Checks whether dashboards exist for current user. Returns sanitized array of existing dashboards according to user’s permissions to access or drill to them.

validateDashboardsExistence(dashboardRefs: ObjRef[]): Promise<IExistingDashboard[]>;

Parameters

Returns

Promise<IExistingDashboard[]>