IWidgetAlertBase

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

Common widget alert properties

export interface IWidgetAlertBase

Properties

Property	Modifiers	Type	Description
dashboard	`readonly`	ObjRef	*(ALPHA)* KPI can be on more dashboards - we need to distinguish which dashboard can be used as link in dashboard alerting email
description	`readonly`	string	*(ALPHA)* Kpi alert description
isTriggered	`readonly`	boolean	*(ALPHA)* Is alert triggered?
threshold	`readonly`	number	*(ALPHA)* Threshold
title	`readonly`	string	*(ALPHA)* Kpi alert title
whenTriggered	`readonly`	“underThreshold” \| “aboveThreshold”	*(ALPHA)* Rule to apply
widget	`readonly`	ObjRef	*(ALPHA)* Kpi ref (currently only kpi widget alerts are supported)

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

KPI can be on more dashboards - we need to distinguish which dashboard can be used as link in dashboard alerting email

readonly dashboard: ObjRef;

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

Kpi alert description

readonly description: string;

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

Is alert triggered?

readonly isTriggered: boolean;

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

Threshold

readonly threshold: number;

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

Kpi alert title

readonly title: string;

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

Rule to apply

readonly whenTriggered: "underThreshold" | "aboveThreshold";

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

Kpi ref (currently only kpi widget alerts are supported)

readonly widget: ObjRef;