IWidgetAlertBase
Home > @gooddata/sdk-model > IWidgetAlertBase
IWidgetAlertBase interface
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.
Common widget alert properties
Signature:
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) |