queryWidgetAlertCount()

Home > @gooddata/sdk-ui-dashboard > queryWidgetAlertCount

queryWidgetAlertCount() function

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.

Creates action through which you can query dashboard component for information about the total number of alerts all the users have set on a given KPI widget.

Signature:

export declare function queryWidgetAlertCount(widgetRef: ObjRef, correlationId?: string): IQueryWidgetAlertCount;

Parameters

Parameter	Type	Description
widgetRef	ObjRef	reference to the KPI widget
correlationId	string	(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing

Returns:

IQueryWidgetAlertCount