/watcher/threshold - Anomify API

Request

Query Params

chips

string

required

Comma-separated list of chips to create the watcher with. Example: cpu,idle.

alert

string

optional

Boolean: Whether the watcher should be configured to alert. Defaults to false if not specified. Example: true.

name

string

required

A name for the watcher. Example: My Brand New Watcher.

alert_slack_channel

string

optional

A slack channel to alert to. Example: anomify-alerts.

alert_teams_webhook_url

string

optional

A Microsoft Teams webhook to alert to. Example: https://xxx.webhook.office.com/abcdef.

expiration_time_unit

string

optional

Units for expiration_time parameter. Can be second (default), minute, hour, day, or week. Example: minute.

expiration_time

string

optional

Expiration time for alerts, specified in units as per expiration_time_unit. Defaults to 3600. Example: 3.

alert_email_recipient_ids

string

optional

Comma-separated list of user ids to receive real-time alerts by email. Example: 101,102.

alert_sms_recipient_ids

string

optional

Comma-separated list of user ids to receive real-time alerts by SMS. Example: 101,102.

mention_slack_recipient_ids

string

optional

Comma-separated list of user ids to be mentioned in Slack alerts. Example: 101,102.

summary_report_schedule

string

optional

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.

summary_report_recipient_ids

string

optional

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.

send_test_alert

string

optional

"true" or "false", whether to fire a test alert when the watcher is created. Example: true.

Body Params application/x-www-form-urlencoded

chips

string

required

Comma-separated list of chips to create the watcher with. Example: cpu,idle.

alert

string

optional

Boolean: Whether the watcher should be configured to alert. Defaults to false if not specified. Example: true.

name

string

required

A name for the watcher. Example: My Brand New Watcher.

alert_slack_channel

string

optional

A slack channel to alert to. Example: anomify-alerts.

alert_teams_webhook_url

string

optional

A Microsoft Teams webhook to alert to. Example: https://xxx.webhook.office.com/abcdef.

expiration_time_unit

string

optional

Units for expiration_time parameter. Can be second (default), minute, hour, day, or week. Example: minute.

expiration_time

number

optional

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.

alert_email_recipient_ids

string

optional

Comma-separated list of user ids to receive real-time alerts by email. Example: 101,102.

alert_sms_recipient_ids

string

optional

Comma-separated list of user ids to receive real-time alerts by SMS. Example: 101,102.

mention_slack_recipient_ids

string

optional

Comma-separated list of user ids to be mentioned in Slack alerts. Example: 101,102.

send_test_alert

string

optional

"true" or "false", whether to fire a test alert when the watcher is created. Example: true.

lower_warning_value

number

optional

Not Yet Implemented

lower_critical_value

number

optional

The level at which to issue a 'critical' alert (optional)

lower_num_samples

integer

optional

The number of samples in a row which must exceed the threshold (default 1 if not specified)

upper_warning_value

number

optional

Not Yet Implemented

upper_critical_value

number

optional

The level at which to issue a 'critical' alert (optional)

upper_num_samples

integer

optional

The number of samples in a row which must exceed the threshold (default 1 if not specified)

minimum_average_value

number

optional

TBC

minimum_average_seconds

string

optional

TBC

function_name

string

optional

Not yet implemented

function_seconds

integer

optional

Not yet implemented

lower enabled

string

optional

Lower threshold enabled? ("true" or "false")

upper_enabled

string

optional

Upper threshold enabled? ("true" or "false")

doac_enabled

string

optional

Sudden Drop Detection enabled? ("true" or "false")

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/watcher/threshold?chips=&alert=&name=&alert_slack_channel=&alert_teams_webhook_url=&expiration_time_unit=&expiration_time=&alert_email_recipient_ids=&alert_sms_recipient_ids=&mention_slack_recipient_ids=&summary_report_schedule=&summary_report_recipient_ids=&send_test_alert=' \
--data-urlencode 'chips=' \
--data-urlencode 'alert=' \
--data-urlencode 'name=' \
--data-urlencode 'alert_slack_channel=' \
--data-urlencode 'alert_teams_webhook_url=' \
--data-urlencode 'expiration_time_unit=' \
--data-urlencode 'expiration_time=' \
--data-urlencode 'alert_email_recipient_ids=' \
--data-urlencode 'alert_sms_recipient_ids=' \
--data-urlencode 'mention_slack_recipient_ids=' \
--data-urlencode 'send_test_alert=' \
--data-urlencode 'lower_warning_value=' \
--data-urlencode 'lower_critical_value=' \
--data-urlencode 'lower_num_samples=' \
--data-urlencode 'upper_warning_value=' \
--data-urlencode 'upper_critical_value=' \
--data-urlencode 'upper_num_samples=' \
--data-urlencode 'minimum_average_value=' \
--data-urlencode 'minimum_average_seconds=' \
--data-urlencode 'function_name=' \
--data-urlencode 'function_seconds=' \
--data-urlencode 'lower enabled=' \
--data-urlencode 'upper_enabled=' \
--data-urlencode 'doac_enabled='

Responses

🟢200An example Response

application/json

Body

status

object (API Response Status)

required

created_timestamp

integer

required

Response created timestamp

created_string

string

required

Response created date/time string

duration

number

required

Duration of response, seconds

language

string

required

Language

timezone

object (Timezone)

required

code

enum<integer>

required

Response code, following HTTP status spec

Allowed values:

200202203204307400401404418500501

oldest_cached_component_age

integer

required

Age in seconds of oldest cached component

session_id

string

required

Session id

org_onboarding_status_id

integer | null

required

Org onboarding status id

api_host

string | null

required

API host

user_onboarding_flags

object (User Onboarding Flags)

optional

org_upgraded

integer | boolean

required

data

object

required

watcher

object (Watcher)

required

Example

{
  "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
        }
      }
    }
  }
}