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: /doc/openapi

Detail

If requested with parameters, updates the onboarding status of the user.

Always returns the current onboarding state.

Parameters

Key Required Example Description
main_intro no true/false flag
alerts_intro no true/false flag
alerts_from_search no true/false flag
training_intro no true/false flag

Example Output

{
    "status": { ... see /login method for status block structure ... },
    "data": {
        "message": "OK",
        "onboarding_flags": {
            "main_intro": false,
            "alerts_intro": false,
            "alerts_from_search": false,
            "training_intro": false,
            "alert_created": true,
            "test_alert_sent": true,
            "two_alerts_sent": true,
            "pattern_trained": true
        }
    }
}

Live Request

URL: /doc/openapi

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.