Anomify API Documentation
Anomify AI Main Site | Anomify Documentation
This copy of our API documentation is no longer updated and may be inaccurate. Please go to http://api-docs.anomify.ai/.

/anomalies

/anomalies

/anomaly

/anomaly/lookup
/anomaly/train
/anomaly/{anomaly_id}

/billing

/billing/checkoutcallback
/billing/getcheckoutsession
/billing/getportalsession
/billing/history

/doc

/doc/openapi

/exclusion

/exclusion/add
/exclusion/delete
/exclusion/list
/exclusion/test
/exclusion/types

/image

/image/anomaly
/image/metric

/js

/js/eventsender

/login

/login

/login DEBUG 100

/login DEBUG 100

/login DEBUG 1069

/login DEBUG 1069

/login DEBUG STAGE

/login DEBUG STAGE

/login

/login/forgotpassword
/login/resetpassword
/login/validateclient

/match

/match/{match_id}
/match/{match_id}/graph
/match/{match_id}/motif/graph

/metric

/metric/{metric_name}
/metric/{metric_name}/anomalies
/metric/{metric_name}/anomalysummary
/metric/{metric_name}/bundle
/metric/{metric_name}/graph
/metric/{metric_name}/patterns
/metric/{metric_name}/timeseries
/metric/{metric_name}/yhat

/metrics

/metrics
/metrics/mostanomalous
/metrics/mostrecentlyanomalous
/metrics/mostrecentlymatched

/misc

/misc/phonecodes
/misc/timesince
/misc/timezones

/org

/org/adminalert/{alert_code}
/org/adminalerts
/org/channels
/org/events
/org/getquotametrics
/org/graph
/org/info
/org/removequotametrics
/org/stripecallback
/org/summary
/org/testmetrics
/org/update
/org/users

/pattern

/pattern/{pattern_id}
/pattern/{pattern_id}/disable
/pattern/{pattern_id}/matches
/pattern/{pattern_id}/timeseries

/patterns

/patterns/pending

/ping

/ping

/signup

/signup/demo
/signup/demo-orgs
/signup/selfserve
/signup/verify

/status

/status

/user

/user/delete
/user/info
/user/logout
/user/ping
/user/reportissue
/user/update
/user/updatepassword

/watcher

/watcher/create
/watcher/{watcher_id}/delete
/watcher/{watcher_id}/undelete
/watcher/{watcher_id}/update

/watchers

/watchers/chips
/watchers/list

Method: /org/adminalerts

Detail

This method is not available to demo user accounts.

Return a list of admin alerts which have been set up, and update them if parameters are supplied.

Parameters

For each alert type id, specified in place of the "x" below, i.e. "type_1_enabled"

Currently alert type ids are:

Id Name
1 All metrics stop receiving data
2 Some metrics stop receiving data

Ids replace the "{id}" value in params below.

Key Required Example Description
type_{id}_enabled no true Boolean, whether the alert is enabled or not
type_{id}_email_users no 101,102 A comma-separated list of valid user ids
type_{id}_sms_users no 101,102 A comma-separated list of valid user ids
type_{id}_slack_channel no anomify-alerts A valid Slack channel
type_{id}_wait_seconds no 300 Wait seconds. Minimum accepted value is 300

Example Output

{
    "status": { ... see /login method for status block structure ... },
    "data": {
        "admin_alerts": [
            {
                "id": 1,
                "name": "[name redacted]",
                "wait_seconds": 500,
                "expiration_seconds": 3600,
                "enabled": true,
                "alerts": [
                    {
                        "method": "email",
                        "ref": "101",
                        "user": {
                            "id": 101,
                            "org_id": 101,
                            "name": "[name redacted]",
                            "email": "[email redacted]",
                            "phone_number": "[phone number redacted]",
                            "slack_member_id": "[slack member id redacted]",
                            "demo": false,
                            "admin": true,
                            "org": {
                                "id": 101,
                                "name": "[name redacted]",
                                "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
                            }
                        }
                    },
                    {
                        "method": "email",
                        "ref": "102",
                        "user": {
                            "id": 102,
                            "org_id": 101,
                            "name": "[name redacted]",
                            "email": "[email redacted]",
                            "phone_number": null,
                            "slack_member_id": null,
                            "demo": false,
                            "admin": true,
                            "org": {
                                "id": 101,
                                "name": "[name redacted]",
                                "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": true,
                                "alerts_from_search": true,
                                "training_intro": false,
                                "alert_created": true,
                                "test_alert_sent": true,
                                "two_alerts_sent": true,
                                "pattern_trained": true
                            }
                        }
                    },
                    {
                        "method": "sms",
                        "ref": "101",
                        "user": {
                            "id": 101,
                            "org_id": 101,
                            "name": "[name redacted]",
                            "email": "[email redacted]",
                            "phone_number": "[phone number redacted]",
                            "slack_member_id": "[slack member id redacted]",
                            "demo": false,
                            "admin": true,
                            "org": {
                                "id": 101,
                                "name": "[name redacted]",
                                "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
                            }
                        }
                    },
                    {
                        "method": "sms",
                        "ref": "102",
                        "user": {
                            "id": 102,
                            "org_id": 101,
                            "name": "[name redacted]",
                            "email": "[email redacted]",
                            "phone_number": null,
                            "slack_member_id": null,
                            "demo": false,
                            "admin": true,
                            "org": {
                                "id": 101,
                                "name": "[name redacted]",
                                "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": true,
                                "alerts_from_search": true,
                                "training_intro": false,
                                "alert_created": true,
                                "test_alert_sent": true,
                                "two_alerts_sent": true,
                                "pattern_trained": true
                            }
                        }
                    },
                    {
                        "method": "slack",
                        "ref": "anomalarm-demo"
                    }
                ]
            },
            {
                "id": 3,
                "name": "[name redacted]",
                "wait_seconds": 900,
                "expiration_seconds": null,
                "enabled": false,
                "alerts": []
            },
            {
                "id": 2,
                "name": "[name redacted]",
                "wait_seconds": 7400,
                "expiration_seconds": null,
                "enabled": true,
                "alerts": [
                    {
                        "method": "sms",
                        "ref": "101",
                        "user": {
                            "id": 101,
                            "org_id": 101,
                            "name": "[name redacted]",
                            "email": "[email redacted]",
                            "phone_number": "[phone number redacted]",
                            "slack_member_id": "[slack member id redacted]",
                            "demo": false,
                            "admin": true,
                            "org": {
                                "id": 101,
                                "name": "[name redacted]",
                                "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
                            }
                        }
                    },
                    {
                        "method": "slack",
                        "ref": "anomalarm-dev"
                    }
                ]
            }
        ],
        "message": "OK"
    }
}

Live Request

URL: /org/adminalerts

You need to be logged in to your Anomify account to to make live API requests.

Please log in here or sign up to Anomify

Email
Password 

Live request results will appear here.