/watcher/threshold/{watcher_id}

Request

Path Params

watcher_id

string

required

Body Params application/x-www-form-urlencoded

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.

chips

string

required

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

alert_slack_channel

string

optional

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

expiration_time_seconds

number

optional

Expiration time for alerts, specified in seconds Must be a minimum of 900 seconds (15 minutes).

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.

alert_teams_webhook_url

string

optional

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

mention_slack_recipient_ids

string

optional

send_test_alert

string

optional

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

function_name

string

optional

Not yet implemented

function_seconds

integer

optional

Not yet implemented

lower_critical_value

number

optional

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

lower_enabled

string

optional

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

lower_num_samples

integer

optional

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

lower_warning_value

number

optional

Not Yet Implemented

upper_critical_value

number

optional

The level at which to issue a Ucritical* alert (optional)

upper_enabled

string

optional

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

upper_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

doac_enabled

string

optional

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

minimum_average_seconds

string

optional

TBC

minimum_average_value

number

optional

TBC

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT '/watcher/threshold/' \
--data-urlencode 'alert=' \
--data-urlencode 'name=' \
--data-urlencode 'chips=' \
--data-urlencode 'alert_slack_channel=' \
--data-urlencode 'expiration_time_seconds=' \
--data-urlencode 'alert_email_recipient_ids=' \
--data-urlencode 'alert_sms_recipient_ids=' \
--data-urlencode 'alert_teams_webhook_url=' \
--data-urlencode 'mention_slack_recipient_ids=' \
--data-urlencode 'send_test_alert=' \
--data-urlencode 'function_name=' \
--data-urlencode 'function_seconds=' \
--data-urlencode 'lower_critical_value=' \
--data-urlencode 'lower_enabled=' \
--data-urlencode 'lower_num_samples=' \
--data-urlencode 'lower_warning_value=' \
--data-urlencode 'upper_critical_value=' \
--data-urlencode 'upper_enabled=' \
--data-urlencode 'upper_num_samples=' \
--data-urlencode 'upper_warning_value=' \
--data-urlencode 'doac_enabled=' \
--data-urlencode 'minimum_average_seconds=' \
--data-urlencode 'minimum_average_value='

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": 1701169087,
        "created_string": "Tue 28 Nov 2023 @ 10:58 (GMT)",
        "duration": 0.053,
        "language": "en-gb",
        "timezone": {
            "timezone_type": 3,
            "timezone": "Europe/London"
        },
        "code": 200,
        "oldest_cached_component_age": 383,
        "session_id": "5624e394cf1d3eaf5a136c9f1dc009e7",
        "org_onboarding_status_id": 300,
        "org_upgraded": 100000,
        "api_host": "anomalarm.dev.dropbox.dev.local",
        "user_onboarding_flags": {
            "main_intro": false,
            "alerts_intro": false,
            "alerts_from_search": false,
            "training_intro": true,
            "alert_created": true,
            "test_alert_sent": false,
            "two_alerts_sent": false,
            "pattern_trained": false,
            "seen_card_anomalies": false,
            "seen_card_matches": false,
            "seen_card_training": false,
            "seen_card_all": false
        }
    },
    "data": {
        "watcher": {
            "id": 293,
            "type": "threshold",
            "name": "Great Lakes bush viper",
            "is_alert": true,
            "is_deleted": false,
            "expiration_time_seconds": 3600,
            "owner": {
                "id": 101,
                "org_id": 101,
                "name": "undefined",
                "email": "si@anomify.ai",
                "phone_number": "",
                "slack_member_id": "",
                "demo": false,
                "org_admin": true,
                "system_admin": true,
                "org": {
                    "id": 101,
                    "name": "undefined",
                    "timezone": "Europe/London",
                    "alert_muting": {
                        "muted": false,
                        "muted_until_timestamp": null,
                        "muted_until_timestamp_string": null,
                        "minutes_remaining": null
                    },
                    "onboarding_status_id": 300,
                    "connected_services": {
                        "slack": false,
                        "ms_teams": false
                    }
                },
                "notifications": {
                    "email_alerts": false
                },
                "onboarding_flags": {
                    "main_intro": false,
                    "alerts_intro": false,
                    "alerts_from_search": false,
                    "training_intro": true,
                    "alert_created": true,
                    "test_alert_sent": false,
                    "two_alerts_sent": false,
                    "pattern_trained": false,
                    "seen_card_anomalies": false,
                    "seen_card_matches": false,
                    "seen_card_training": false,
                    "seen_card_all": false
                }
            },
            "threshold": {
                "lower_level_warning": "3.000000",
                "lower_level_critical": "3.000000",
                "lower_num_samples": "10",
                "upper_level_warning": "18.000000",
                "upper_level_critical": "18.000000",
                "upper_num_samples": "10",
                "minimum_average_value": "2.000000",
                "minimum_average_seconds": "3",
                "flags": {
                    "lower_enabled": true,
                    "upper_enabled": false,
                    "doac_enabled": true
                }
            }
        }
    }
}