IQueryWidgetAlertCount
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Given a reference to a KPI widget, this query will obtain the total number of alerts all the users have set on it.
export interface IQueryWidgetAlertCount extends IDashboardQuery
Extends: IDashboardQuery
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| { readonly widgetRef: ObjRef; } | (ALPHA) | |
| “GDC.DASH/QUERY.WIDGET.ALERT_COUNT” | (ALPHA) |
Property details
IQueryWidgetAlertCount.payloadpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly payload: {
readonly widgetRef: ObjRef;
};
IQueryWidgetAlertCount.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly type: "GDC.DASH/QUERY.WIDGET.ALERT_COUNT";