Anomify API
/watcher/threshold
DesigningPOST/watcher/thresholdCreates a threshold watcher.
Request
Comma-separated list of chips to create the watcher with. Example: cpu,idle.
Boolean: Whether the watcher should be configured to alert. Defaults to false if not specified. Example: true.
A name for the watcher. Example: My Brand New Watcher.
A slack channel to alert to. Example: anomify-alerts.
A Microsoft Teams webhook to alert to. Example: https://xxx.webhook.office.com/abcdef.
Units for expiration_time parameter. Can be second (default), minute, hour, day, or week. Example: minute.
Expiration time for alerts, specified in units as per expiration_time_unit. Defaults to 3600. Example: 3.
Comma-separated list of user ids to receive real-time alerts by email. Example: 101,102.
Comma-separated list of user ids to receive real-time alerts by SMS. Example: 101,102.
Comma-separated list of user ids to be mentioned in Slack alerts. Example: 101,102.
When to send summary reports. Valid example values are daily-10:00, weekly-monday, monthly-17. If this is not set, summary reports are not enabled. Example: daily-10:00.
Comma-separated list of user ids to receive summary reports by email. If 'summary_report_frequency' has been specified, at least one user id must be specified here. Example: 101,102.
"true" or "false", whether to fire a test alert when the watcher is created. Example: true.
Comma-separated list of chips to create the watcher with. Example: cpu,idle.
Boolean: Whether the watcher should be configured to alert. Defaults to false if not specified. Example: true.
A name for the watcher. Example: My Brand New Watcher.
A slack channel to alert to. Example: anomify-alerts.
A Microsoft Teams webhook to alert to. Example: https://xxx.webhook.office.com/abcdef.
Units for expiration_time parameter. Can be second (default), minute, hour, day, or week. Example: minute.
Expiration time for alerts, specified in units as per expiration_time_unit. Defaults to 3600. Example: 3. Must be a minimum of 900 seconds (15 minutes) when the expiration_time_unit is taken into account.
Comma-separated list of user ids to receive real-time alerts by email. Example: 101,102.
Comma-separated list of user ids to receive real-time alerts by SMS. Example: 101,102.
Comma-separated list of user ids to be mentioned in Slack alerts. Example: 101,102.
"true" or "false", whether to fire a test alert when the watcher is created. Example: true.
Not Yet Implemented
The level at which to issue a 'critical' alert (optional)
The number of samples in a row which must exceed the threshold (default 1 if not specified)
Not Yet Implemented
The level at which to issue a 'critical' alert (optional)
The number of samples in a row which must exceed the threshold (default 1 if not specified)
TBC
TBC
Not yet implemented
Not yet implemented
Lower threshold enabled? ("true" or "false")
Upper threshold enabled? ("true" or "false")
Sudden Drop Detection enabled? ("true" or "false")
Request samples
Responses
{
"status": {
"created_timestamp": 1657644963,
"created_string": "Tue 12 Jul 2022 @ 16:56 (UTC)",
"duration": 0.243,
"language": "en-gb",
"timezone": {
"timezone_type": 3,
"timezone": "UTC"
},
"code": 200,
"oldest_cached_component_age": 9589041,
"session_id": "1dedbf232bc104b6087327016c50ba45",
"org_onboarding_status_id": 300,
"api_host": "api-stage.anomify.ai",
"user_onboarding_flags": {
"main_intro": true,
"alerts_intro": false,
"alerts_from_search": false,
"training_intro": false,
"alert_created": true,
"test_alert_sent": true,
"two_alerts_sent": true,
"pattern_trained": true
}
},
"data": {
"test_metric": null,
"test_metric_last_analyzed": null,
"watcher": {
"id": 343,
"name": "Si Test Alert 2022-07-12 01",
"is_alert": true,
"is_deleted": false,
"owner": {
"id": 101,
"org_id": 101,
"name": "Phil Collins",
"email": "si@anomalarm.io",
"phone_number": "+447976123456",
"slack_member_id": "U04UFSKFY",
"demo": false,
"admin": true,
"org": {
"id": 101,
"name": "Anomify",
"timezone": "UTC",
"alert_muting": {
"muted": false,
"muted_until_timestamp": null,
"muted_until_timestamp_string": null,
"minutes_remaining": null
},
"onboarding_status_id": 300,
"connected_services": {
"slack": true,
"ms_teams": false
}
},
"notifications": {
"email_alerts": true
},
"onboarding_flags": {
"main_intro": true,
"alerts_intro": false,
"alerts_from_search": false,
"training_intro": false,
"alert_created": true,
"test_alert_sent": true,
"two_alerts_sent": true,
"pattern_trained": true
}
}
}
}
}