# Honeycomb Anomaly Detection API

**Canonical:** https://apis.io/apis/honeycomb/honeycomb-anomaly-detection-api/  
**Provider:** Honeycomb — https://apis.io/providers/honeycomb/  
**Base URL:** https://api.honeycomb.io  
**Documentation:** https://api-docs.honeycomb.io/api/events

Honeycomb Anomaly Detection API is one of 22 APIs that [Honeycomb](https://apis.io/providers/honeycomb/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Anomaly Detection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

Anomaly Detection identifies Signals - patterns in your services that deviate from their historical baseline - and can notify Recipients when a Signal turns anomalous. Each Signal is scoped to a service in a dataset and monitors one of the following: - **`error_rate`**: The fraction of erroring requests, compared to a trained normal band. - **`presence`**: Whether the service is emitting spans at all. Signals progress through the following statuses: - **`onboarding`**: The Signal has been created but does not yet have enough data to train. - **`normal`**: The Signal is trained and monitoring for anomalies. - **`anomalous`**: The Signal has detected an anomaly. - **`off`**: The Signal has been disabled and will not fire. - **`ineligible`**: The Signal cannot train because its service is not sending enough traffic to establish a reliable baseline. This API allows you to list Signals, retrieve a Signal with its assigned Recipients, page through a Signal's historical anomalies, and update a Signal's enabled state, sensitivity, and Recipient assignments. ## Authorization The API key must have the **Manage Signals** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| GET | `/1/signals` | List All Signals |
| GET | `/1/signals/{signalId}` | Get a Signal |
| PUT | `/1/signals/{signalId}` | Update a Signal |
| GET | `/1/signals/{signalId}/historical_anomalies` | List Historical Anomalies |
| POST | `/1/signals/recipient_assignments` | Assign Recipients in Bulk |

## Machine-readable artifacts (3)

- **OpenAPI** — https://artifacts.apis.io/honeycomb/openapi/honeycomb-anomaly-detection-api-openapi.yml
- **Documentation** — https://api-docs.honeycomb.io/api
- **JSONSchema** — https://artifacts.apis.io/honeycomb/json-schema/honeycomb-query-result-schema.json

## Other Honeycomb APIs (12)

- [Honeycomb Events API](https://apis.io/apis/honeycomb/events-api/)
- [Honeycomb Queries API](https://apis.io/apis/honeycomb/queries-api/)
- [Honeycomb Datasets API](https://apis.io/apis/honeycomb/datasets-api/)
- [Honeycomb Boards API](https://apis.io/apis/honeycomb/boards-api/)
- [Honeycomb Markers API](https://apis.io/apis/honeycomb/markers-api/)
- [Honeycomb Triggers API](https://apis.io/apis/honeycomb/triggers-api/)
- [Honeycomb Environments API](https://apis.io/apis/honeycomb/environments-api/)
- [honeycomb Auth API](https://apis.io/apis/honeycomb/honeycomb-auth-api/)
- [honeycomb Burn Alerts API](https://apis.io/apis/honeycomb/honeycomb-burn-alerts-api/)
- [honeycomb Calculated Fields API](https://apis.io/apis/honeycomb/honeycomb-calculated-fields-api/)
- [honeycomb Columns API](https://apis.io/apis/honeycomb/honeycomb-columns-api/)
- [honeycomb Dataset Definitions API](https://apis.io/apis/honeycomb/honeycomb-dataset-definitions-api/)

## Tags

Anomaly Detection

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/honeycomb/honeycomb-anomaly-detection-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/honeycomb/.
