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/summary

Detail

This method is not available to demo user accounts.

Return summary statistics for an organization. If a metric is specified, relevant stats are limited to that metric.

Parameters

Key Required Example Description
from no 1588603852 Timestamp. Not yet implemented.
until no 1588690252 Timestamp Not yet implemented.
metric no grph_1.cloudinfra.mx-out02.network.eth0.rx_byte Metric name

If no from/until are specified, we will use the last 7 days rounded to the last full minute.

Example Output

{
    "status": { ... see /login method for status block structure ... },
    "data": {
        "report_period": {
            "name": "[name redacted]",
            "from_timestamp": 1657036440,
            "from_string": "July 5th, 15:54",
            "until_timestamp": 1657641240,
            "until_string": "July 12th, 15:54"
        },
        "total_values": {
            "active_metrics": 75,
            "enabled_alerts": 17,
            "active_patterns": 950
        },
        "period_values": {
            "anomalies": 12,
            "patterns_created": 0,
            "pattern_matches": 132,
            "reduced_alerts": 91.67,
            "analyzed_events": 536794
        }
    }
}

Live Request

URL: /org/summary

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.