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: /anomaly/lookup

Detail

This method is not available to demo user accounts.

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.

Parameters

Key Required Example Description
metric yes graphite-labs_wikimedia_org.cloudinfra.cloud-cumin-01.cpu.total.system The anomalous metric
timestamp yes 1588689360 The anomaly timestamp

Example Output

A successful response is identical to the /anomaly/x method - see that method's documentation for example.

However, if the anomaly timestamp is less than 20 seconds old, we may not have it yet, although it is expected that it will be available soon, so we return a message as follows:

{
    "status": { ... see /login method for status block structure ... },
    "data": {
        "anomaly": {
            "id": 7786,
            "metric_id": 982,
            "metric": "grph_1.cloudinfra.mx-out02.network.eth0.tx_byte",
            "value": 12183.4,
            "timestamp": 1588685340,
            "timestamp_string": "May 5th 2020, 13:29",
            "until_timestamp": 1588685460,
            "score": 0.78,
            "training": {
                "trainable": false,
                "trainable_status": "expired",
                "trainable_until_timestamp": null,
                "30_day_trainable_from_timestamp": null,
                "30_day_trainable_in": null
            },
            "patterns": [],
            "positive": false,
            "expected_range_lower": 0,
            "expected_range_upper": 0,
            "expected_range_lower_string": "0",
            "expected_range_upper_string": "0",
            "pending_patterns": []
        },
        "anomaly_graph_url": "https:\/\/api-stage.anomify.ai\/metric\/grph_1.cloudinfra.mx-out02.network.eth0.tx_byte\/graph?from=1586093340&until=1588685340&display_x_axis=neither&display_y_axis=neither&display_legend=true&display_anomalies=false&display_matches=false&context=anomaly_30_day",
        "pattern_graph_urls": {},
        "matching_watchers": [
            {
                "id": 265,
                "name": "[name redacted]",
                "is_alert": true,
                "is_deleted": false,
                "owner": {
                    "id": 103,
                    "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": true,
                        "alerts_from_search": true,
                        "training_intro": true,
                        "alert_created": true,
                        "test_alert_sent": true,
                        "two_alerts_sent": true,
                        "pattern_trained": true
                    }
                }
            },
            {
                "id": 209,
                "name": "[name redacted]",
                "is_alert": true,
                "is_deleted": false,
                "owner": {
                    "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
                    }
                }
            },
            {
                "id": 264,
                "name": "[name redacted]",
                "is_alert": true,
                "is_deleted": false,
                "owner": {
                    "id": 103,
                    "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": true,
                        "alerts_from_search": true,
                        "training_intro": true,
                        "alert_created": true,
                        "test_alert_sent": true,
                        "two_alerts_sent": true,
                        "pattern_trained": true
                    }
                }
            },
            {
                "id": 221,
                "name": "[name redacted]",
                "is_alert": true,
                "is_deleted": false,
                "owner": {
                    "id": 151,
                    "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": true,
                        "alerts_from_search": true,
                        "training_intro": true,
                        "alert_created": true,
                        "test_alert_sent": true,
                        "two_alerts_sent": true,
                        "pattern_trained": true
                    }
                }
            },
            {
                "id": 181,
                "name": "[name redacted]",
                "is_alert": true,
                "is_deleted": false,
                "owner": {
                    "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
                    }
                }
            },
            {
                "id": 268,
                "name": "[name redacted]",
                "is_alert": true,
                "is_deleted": false,
                "owner": {
                    "id": 151,
                    "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": true,
                        "alerts_from_search": true,
                        "training_intro": true,
                        "alert_created": true,
                        "test_alert_sent": true,
                        "two_alerts_sent": true,
                        "pattern_trained": true
                    }
                }
            }
        ],
        "related": {
            "status": {
                "code": 500,
                "message": "Something went wrong"
            }
        }
    }
}

Live Request

URL: /anomaly/lookup

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.