{"_id":"55fc9b7c3c21291900e7e0ed","__v":0,"version":{"_id":"55fc9b793c21291900e7e0d7","__v":12,"project":"5553d36165e8260d0024419a","createdAt":"2015-09-18T23:17:13.545Z","releaseDate":"2015-09-18T23:17:13.545Z","categories":["55fc9b7a3c21291900e7e0d8","55fc9b7a3c21291900e7e0d9","55fc9b7a3c21291900e7e0da","55fc9b7a3c21291900e7e0db","55fc9b7a3c21291900e7e0dc","55fc9b7a3c21291900e7e0dd","55fc9b7a3c21291900e7e0de","55fc9b7a3c21291900e7e0df","55fc9b7a3c21291900e7e0e0","55fc9b7a3c21291900e7e0e1","55fc9b7a3c21291900e7e0e2","55fc9b7a3c21291900e7e0e3","55fc9bad4c80910d00b9bece","56394a0c3539050d00082122","56394a2f68b11f0d0048c9ff","56394a462fc5520d001a4db3","56394a4c2fc5520d001a4db4","56394a5b049e420d00476b5c","56394a6a2fc5520d001a4db5","56394f791593e4190073a44b","567b3adfb56bac0d0019d8d9","569d590e5a2b060d008741eb","569ea93dffccd10d00a05c7f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55fc9b7a3c21291900e7e0e3","project":"5553d36165e8260d0024419a","version":"55fc9b793c21291900e7e0d7","__v":1,"pages":["55fc9b7c3c21291900e7e0ed"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-14T20:20:02.168Z","from_sync":false,"order":10,"slug":"notifications-and-alerts","title":"Notifications and Alerts"},"parentDoc":null,"user":"5553d33065e8260d00244199","project":"5553d36165e8260d0024419a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-14T20:26:13.077Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Alert Types\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"On Failure\",\n  \"body\": \"An alert is triggered when an API fails either with a 4XX or 5XX error.  Using advanced options, it is possible to set custom errors including capturing HTTP 200 error messages.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Latency Exceeds a Defined Target\",\n  \"body\": \"An alert can be triggered when latency exceeds a pre-defined time set in milliseconds\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Latency Goes Outside Expected Statistical Variance\",\n  \"body\": \"APImetrics tracks the average and median performance of any given API deployment, and alerts can be triggered in the event an API call exceeds an expected tolerance expressed in a number of standard deviations from the mean.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Other Filters\"\n}\n[/block]\nBecause services can be inherently unreliable, it is possible to set thresholds on the event triggers, usually expressed by the number of failures expected per day or as a percentage before an alert is triggered.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Output Options\"\n}\n[/block]\nDifferent email addresses can be set to be triggered when different alert conditions are met.","excerpt":"","slug":"setting-alerts","type":"basic","title":"Setting Alerts"}
[block:api-header] { "type": "basic", "title": "Alert Types" } [/block] [block:callout] { "type": "info", "title": "On Failure", "body": "An alert is triggered when an API fails either with a 4XX or 5XX error. Using advanced options, it is possible to set custom errors including capturing HTTP 200 error messages." } [/block] [block:callout] { "type": "info", "title": "Latency Exceeds a Defined Target", "body": "An alert can be triggered when latency exceeds a pre-defined time set in milliseconds" } [/block] [block:callout] { "type": "info", "title": "Latency Goes Outside Expected Statistical Variance", "body": "APImetrics tracks the average and median performance of any given API deployment, and alerts can be triggered in the event an API call exceeds an expected tolerance expressed in a number of standard deviations from the mean." } [/block] [block:api-header] { "type": "basic", "title": "Other Filters" } [/block] Because services can be inherently unreliable, it is possible to set thresholds on the event triggers, usually expressed by the number of failures expected per day or as a percentage before an alert is triggered. [block:api-header] { "type": "basic", "title": "Output Options" } [/block] Different email addresses can be set to be triggered when different alert conditions are met.