Skip to content

Latest commit

 

History

History
36 lines (32 loc) · 4.4 KB

Alert.md

File metadata and controls

36 lines (32 loc) · 4.4 KB

Alert

Properties

Name Type Description Notes
applied_dashboard_filters \Swagger\Client\Model\AlertAppliedDashboardFilter[] Filters coming from the dashboard that are applied. Example `[{ "filter_title": "Name", "field_name": "distribution_centers.name", "filter_value": "Los Angeles CA" }]` [optional]
comparison_type string This property informs the check what kind of comparison we are performing. Only certain condition types are valid for time series alerts. For details, refer to Setting Alert Conditions Valid values are: "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "INCREASES_BY", "DECREASES_BY", "CHANGES_BY".
cron string Vixie-Style crontab specification when to run. At minumum, it has to be longer than 15 minute intervals
custom_url_base string Domain for the custom url selected by the alert creator from the admin defined domain allowlist [optional]
custom_url_params string Parameters and path for the custom url defined by the alert creator [optional]
custom_url_label string Label for the custom url defined by the alert creator [optional]
show_custom_url bool Boolean to determine if the custom url should be used [optional]
custom_title string An optional, user-defined title for the alert [optional]
dashboard_element_id string ID of the dashboard element associated with the alert. Refer to dashboard_element() [optional]
description string An optional description for the alert. This supplements the title [optional]
destinations \Swagger\Client\Model\AlertDestination[] Array of destinations to send alerts to. Must be the same type of destination. Example `[{ "destination_type": "EMAIL", "email_address": "test@test.com" }]`
field \Swagger\Client\Model\AlertField The field the alert threshold is compared against when determining when to send notifications
followed bool Whether or not the user follows this alert. [optional]
followable bool Whether or not the alert is followable [optional]
id string ID of the alert [optional]
is_disabled bool Whether or not the alert is disabled [optional]
disabled_reason string Reason for disabling alert [optional]
is_public bool Whether or not the alert is public [optional]
investigative_content_type string The type of the investigative content Valid values are: "dashboard". [optional]
investigative_content_id string The ID of the investigative content. For dashboards, this will be the dashboard ID [optional]
investigative_content_title string The title of the investigative content. [optional]
lookml_dashboard_id string ID of the LookML dashboard associated with the alert [optional]
lookml_link_id string ID of the LookML dashboard element associated with the alert [optional]
owner_id string User id of alert owner
owner_display_name string Alert owner's display name [optional]
threshold double Value of the alert threshold
time_series_condition_state \Swagger\Client\Model\AlertConditionState (Write-Only) (Optional) Only used when first creating time series alerts. It's used to pick a starting time reference from which alerts will be evaluated again. Without it, alerts be run against all time series data. Refer to docs for details. Example `{ latest_time_series_id: '2020-09-17', previous_time_series_id: '2020-09-16' }`. [optional]

[Back to Model list] [Back to API list] [Back to README]