# Anomify API

## Docs
- [About Anomify](https://api-docs.anomify.ai/doc-375112.md): 
- [Getting Started](https://api-docs.anomify.ai/intro.md): 

## API Docs
- [/anomalies](https://api-docs.anomify.ai/api-4254171.md): Return a list of anomalies in the requested time period, ordered by most recent first.
- [/anomaly/{anomaly_id}](https://api-docs.anomify.ai/api-4254172.md): Get an anomaly by its id.The anomaly id is specified in the URL, e.g.
- [/anomaly/lookup](https://api-docs.anomify.ai/api-4254173.md): Return a summary for an individual anomaly. This method is essentially an alias for /anomaly/x but allows for lookup from metric and timestamp rather than anomaly id. This is useful when the request originates from an alert where the anomaly has not yet been inserted into the DB and no anomaly id exists.
- [/anomaly/train](https://api-docs.anomify.ai/api-4254174.md): Creates a pattern for the given anomaly.
- [/benchmark/models](https://api-docs.anomify.ai/api-12374719.md): Get a list of available models for benchmark testing.
- [/benchmark/start](https://api-docs.anomify.ai/api-10150404.md): Check progress
- [/benchmark/setemailaddress](https://api-docs.anomify.ai/api-12208928.md): Set the notification email address on a benchmark task identified by its URL.
- [/benchmark/status](https://api-docs.anomify.ai/api-11230550.md): Status on benchmark
- [/benchmark/chart](https://api-docs.anomify.ai/api-11666508.md): Status on benchmark
- [/benchmark/chartdata](https://api-docs.anomify.ai/api-11963297.md): Status on benchmark
- [/billing/checkoutcallback](https://api-docs.anomify.ai/api-4254175.md): **DEPRECATED - please use /billing/checkoutcallback** 
- [/billing/getcheckoutsession](https://api-docs.anomify.ai/api-4254176.md): Return the URL to a new Stripe checkout session.
- [/billing/getportalsession](https://api-docs.anomify.ai/api-4254177.md): Return the URL to a new Stripe checkout session.
- [/billing/history](https://api-docs.anomify.ai/api-4254178.md): Return a list of billing/subscription events for the logged-in organization.
- [/doc/openapi](https://api-docs.anomify.ai/api-4254179.md): If requested with parameters, updates the onboarding status of the user.
- [/exclusion/add](https://api-docs.anomify.ai/api-4254180.md): Add a new metric exclusion pattern.
- [/exclusion/delete](https://api-docs.anomify.ai/api-4254181.md): Delete a metric exclusion pattern with the given id.
- [/exclusion](https://api-docs.anomify.ai/api-4417426.md): Add a new metric exclusion pattern.
- [/exclusion/{exclusion_id}](https://api-docs.anomify.ai/api-4417377.md): Delete a metric exclusion pattern with the given id.
- [/exclusion/list](https://api-docs.anomify.ai/api-4254182.md): List current metric exclusion patterns.
- [/exclusion/test](https://api-docs.anomify.ai/api-4254183.md): Test a metric exclusion patterns for validity without adding it.
- [/exclusion/types](https://api-docs.anomify.ai/api-4254184.md): List available exclusion types.
- [/image/anomaly](https://api-docs.anomify.ai/api-4254185.md): Return a graph of a metric with an anomaly highlighted.
- [/image/metric](https://api-docs.anomify.ai/api-4254186.md): Return a graph of a metric.
- [/integration/list](https://api-docs.anomify.ai/api-7602063.md): Get a list of supported integrations. This method currently returns a list of ids which an be used in other integration methods.
- [/integration/{service_id}/orgconfig](https://api-docs.anomify.ai/api-8048610.md): Configure the service identified by {service_id} for the current org
- [/integration/{service_id}/orgproperties](https://api-docs.anomify.ai/api-7604579.md): 
- [/integration/{service_id}/userconfig](https://api-docs.anomify.ai/api-8070127.md): Configure the service identified by {service_id} for the current user.
- [/integration/{service_id}/userproperties](https://api-docs.anomify.ai/api-8070487.md): 
- [/js/eventsender](https://api-docs.anomify.ai/api-4254187.md): Return eventsender JavaScript.
- [/login](https://api-docs.anomify.ai/api-4254188.md): Log in a user and return a session token.
- [/login/forgotpassword](https://api-docs.anomify.ai/api-4254189.md): Initiate the password reset process by sending a reset link to the user's email.
- [/login/resetpassword](https://api-docs.anomify.ai/api-4254190.md): If the provided password reset token is valid, this method will reset the corresponding user's password as specified.
- [/login/validateclient](https://api-docs.anomify.ai/api-4254191.md): Validate a two-factor authentication code for a new client, or refresh of existing client.
- [/match/{match_id}](https://api-docs.anomify.ai/api-4254192.md): Returns match X identified in the URLMatch id is supplied in the URL, e.g.
- [/match/{match_id}/graph](https://api-docs.anomify.ai/api-4254193.md): Return a match graph in PNG format.
- [/match/{match_id}/motif/graph](https://api-docs.anomify.ai/api-4254194.md): Return a motif match graph in PNG format. If the match with the given id is not a motif match, this request will fail.
- [/metric/{metric_name}](https://api-docs.anomify.ai/api-4254195.md): Return a summary for an individual metric.The metric name is specified in the URL, e.g.
- [/metric/{metric_name}/anomalies](https://api-docs.anomify.ai/api-4254196.md): Returns a list of anomalies for the metric supplied in the URL.
- [/metric/{metric_name}/anomalysummary](https://api-docs.anomify.ai/api-4254197.md): Return a summary of anomalies for an individual metric.
- [/metric/{metric_name}/bundle](https://api-docs.anomify.ai/api-4254198.md): Returns a 'bundle' of metric API responses in a single call. This is intended to reduce the number of methods a client building a graph with all this information would need to make.
- [/metric/{metric_name}/graph](https://api-docs.anomify.ai/api-4254199.md): Return a graph in either PNG or JSON format as requested.
- [/metric/{metric_name}/patterns](https://api-docs.anomify.ai/api-4254200.md): Return a list of patterns for the given metric. Patterns groups are indicated by a "group_id" in the response which can be used for display.The metric name is specified in the URL, e.g.
- [/metric/{metric_name}/timeseries](https://api-docs.anomify.ai/api-4254201.md): Returns a timeseries for the metric supplied in the URL.
- [/metric/{metric_name}/yhat](https://api-docs.anomify.ai/api-4254202.md): Return yhat values for the given metric.
- [/metrics](https://api-docs.anomify.ai/api-4254203.md): Return a list of metrics available.
- [/metrics/mostanomalous](https://api-docs.anomify.ai/api-4254204.md): Returns a list of the most anomalous metrics in the time period requested, ordered by most anomalous first. Returns 10 results unless the optional limit parameter is specified.
- [/metrics/mostrecentlyanomalous](https://api-docs.anomify.ai/api-4254205.md): Returns a list of unique metrics which have been anomalous most recently, ordered by the most recent anomaly on each metric. Returns 10 results unless the optional limit parameter is specified.
- [/metrics/mostrecentlymatched](https://api-docs.anomify.ai/api-4254206.md): Returns a list of unique metrics which have had matches most recently, ordered by the most recent match on each metric.
- [/metrics/search](https://api-docs.anomify.ai/api-5895761.md): Return a list of metrics matching the search terms. Results are returned in order of relevance.
- [/misc/phonecodes](https://api-docs.anomify.ai/api-4254207.md): Return a list of international telephone dialling codes supprted by Anomify.
- [/misc/timesince](https://api-docs.anomify.ai/api-4254208.md): Return human-readable "time since" strings to represent the time which has passed since any timestamps presented. The result is an array keyed by the input timestamps.
- [/misc/timezones](https://api-docs.anomify.ai/api-4254209.md): Return a list of valid ISO timezone names supported by Anomify.
- [/org/adminalert/{alert_code}](https://api-docs.anomify.ai/api-4254210.md): Return information for an admin alert identified in the URL.The id of the alert passed in the URL, e.g.
- [/org/adminalerts](https://api-docs.anomify.ai/api-4254211.md): Return a list of admin alerts which have been set up, and update them if parameters are supplied.
- [/org](https://api-docs.anomify.ai/api-4426458.md): Update information for an organization.
- [/org/adminalerts](https://api-docs.anomify.ai/api-4425306.md): Return a list of admin alerts which have been set up, and update them if parameters are supplied.
- [/org/adminalerts](https://api-docs.anomify.ai/api-4424970.md): Update the list of admin alerts which are set up. For each alert type id, specified in place of the "x" below, i.e. "type_1_enabled"
- [/org/channels](https://api-docs.anomify.ai/api-4254212.md): Return a list of configured communication channels available for an organization to communicate alerts through.
- [/org/events](https://api-docs.anomify.ai/api-4254213.md): Return a list of recent (or custom timeframe) events for the current org.
- [/org/getquotametrics](https://api-docs.anomify.ai/api-4254214.md): Return an organization's quota, and a list of metrics currently using that quota.
- [/org/graph](https://api-docs.anomify.ai/api-4254215.md): Return a graph in either PNG or JSON format as requested, summarising activity on your organisation.
- [/org/info](https://api-docs.anomify.ai/api-4254216.md): Return summary info for an organization. API token keys are not visible to demo users and will be replaced in the output.
- [/org/overview](https://api-docs.anomify.ai/api-13340711.md): Return overview statistics for an organization.
- [/org/removequotametrics](https://api-docs.anomify.ai/api-4254217.md): 
- [/org/stripecallback](https://api-docs.anomify.ai/api-4254218.md): **DEPRECATED - please use /billing/checkoutcallback** 
- [/org/summary](https://api-docs.anomify.ai/api-4254219.md): Return summary statistics for an organization. If a metric is specified, relevant stats are limited to that metric.
- [/org/testmetrics](https://api-docs.anomify.ai/api-4254220.md): Return a list of metrics which have been submitted in test mode, using the "X-Test-Only" header. More info about how to send test metrics is available in the Anomify Dashboard.
- [/org/tokens](https://api-docs.anomify.ai/api-6784768.md): Return token information for an org, including secrets.
- [/org/update](https://api-docs.anomify.ai/api-4254221.md): Update information for an organization.
- [/org/users](https://api-docs.anomify.ai/api-4254222.md): Return a list of users on the same organization as the user making the request.
- [/pattern/{pattern_id}](https://api-docs.anomify.ai/api-4254223.md): Returns a summary of the pattern identified in the URL.Pattern id is supplied in the URL, e.g.
- [/pattern/{pattern_id}/disable](https://api-docs.anomify.ai/api-4254224.md): Disables a pattern.The pattern id is supplied in the URL, e.g.
- [/pattern/{pattern_id}/matches](https://api-docs.anomify.ai/api-4254225.md): Returns a list of matches for the pattern identified in the URL.Pattern id is supplied in the URL, e.g.
- [/pattern/{pattern_id}/timeseries](https://api-docs.anomify.ai/api-4254226.md): Returns the timeseries for the pattern identified in the URL.
- [/patterns/pending](https://api-docs.anomify.ai/api-4254227.md): Returns a list of pending patterns. Where a parent_id is specified, the list is filtered to only those that specify the same parent id.
- [/ping](https://api-docs.anomify.ai/api-4254228.md): Does nothing, but returns quickly. Does not require authentication.
- [/ping](https://api-docs.anomify.ai/api-6385896.md): Does nothing, but returns quickly. Does not require authentication.
- [/progress/demo](https://api-docs.anomify.ai/api-6292951.md): A demo of the progress handler.
- [/progress](https://api-docs.anomify.ai/api-6295292.md): Check progress
- [/progress/{progress_id}/update](https://api-docs.anomify.ai/api-6296690.md): Update progress
- [/signup/demo](https://api-docs.anomify.ai/api-4254229.md): Signs up a demo user.
- [/signup/demo-orgs](https://api-docs.anomify.ai/api-4254230.md): Return a list of organizations for demo users to access.
- [/signup/selfserve](https://api-docs.anomify.ai/api-4254231.md): Signs up a new self-serve organization and user. The new user will be sent a verification code via email, the details from which need to be submitted to /signup/verify.
- [/signup/verify](https://api-docs.anomify.ai/api-4254232.md): Verify the email address of a user from the code they were sent via email, and allows them to set their password so they can log in. On successful completion the user is automatically logged in.
- [/status](https://api-docs.anomify.ai/api-4254233.md): Performs all healthchecks on the API and returns a list of statuses of each service, either in the "pass" or "fail" group.
- [/user/delete](https://api-docs.anomify.ai/api-4254234.md): Delete the currently-logged-in user. If this is the only user on the organization, the organization will be deleted as well.
- [/user/info](https://api-docs.anomify.ai/api-4254235.md): Return the currently-logged-in user's info.
- [/user/logout](https://api-docs.anomify.ai/api-4254236.md): Log out the currently logged-in user.
- [/user/ping](https://api-docs.anomify.ai/api-4254237.md): Takes no action, but returns user info quickly, so is useful for getting the server time and local time for the logged-in user.
- [/user/reportissue](https://api-docs.anomify.ai/api-4254238.md): Report an issue and provide an optional file attachment. A user must be logged in to access this method.
- [/user/update](https://api-docs.anomify.ai/api-4254239.md): Update info for the currently-logged-in user and return the user's info after changes.
- [/user](https://api-docs.anomify.ai/api-4426662.md): Update info for the currently-logged-in user and return the user's info after changes.
- [/user/updatepassword](https://api-docs.anomify.ai/api-4254240.md): Update the password for the currently-logged-in user.
- [/user/password](https://api-docs.anomify.ai/api-4461727.md): Update the password for the currently-logged-in user.
- [/watcher/create](https://api-docs.anomify.ai/api-4254241.md): Creates a watcher.
- [/watcher](https://api-docs.anomify.ai/api-4303344.md): Creates an AI watcher.
- [/watcher/threshold](https://api-docs.anomify.ai/api-4556162.md): Creates a threshold watcher.
- [/watcher/{watcher_id}/delete](https://api-docs.anomify.ai/api-4254242.md): Deletes a watcher.The watcher id is provided in URL, e.g.
- [/watcher/{watcher_id}](https://api-docs.anomify.ai/api-5617127.md): Return the full information for the watcher identified by {watcher_id}
- [/watcher/{watcher_id}](https://api-docs.anomify.ai/api-4303369.md): Deletes a watcher of any kind (ai or boundary).
- [/watcher/{watcher_id}/undelete](https://api-docs.anomify.ai/api-4254243.md): Deletes a watcher.The watcher id is provided in URL, e.g.
- [/watcher/{watcher_id}/update](https://api-docs.anomify.ai/api-4254244.md): Updates a watcher.
- [/watcher/{watcher_id}](https://api-docs.anomify.ai/api-4303362.md): Updates an AI watcher
- [/watcher/threshold/{watcher_id}](https://api-docs.anomify.ai/api-4566214.md): Updates a threshold alert.
- [/watchers/chips](https://api-docs.anomify.ai/api-4254245.md): Returns a list of chips which can be used to filter metrics and create watchers.
- [/watchers/list](https://api-docs.anomify.ai/api-4254246.md): Return a list of watchers available to the currently logged-in user.
- [/grafana/metric/{metric_name}/anomalies](https://api-docs.anomify.ai/api-10319243.md): Work in progress.
- [/grafana/metric/{metric_name}/matches](https://api-docs.anomify.ai/api-10341867.md): Work in progress.
- [/grafana/{metric_name}/{panel_name}](https://api-docs.anomify.ai/api-9995226.md): Work in progress.
- [/grafana/org/{panel_name}](https://api-docs.anomify.ai/api-9995232.md): Work in progress.