Get a Signal

curl --request GET \
  --url https://api.honeycomb.io/1/signals/{id} \
  --header 'X-Honeycomb-Team: <api-key>'

const options = {method: 'GET', headers: {'X-Honeycomb-Team': '<api-key>'}};

fetch('https://api.honeycomb.io/1/signals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.honeycomb.io/1/signals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Honeycomb-Team: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.honeycomb.io/1/signals/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Honeycomb-Team", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.honeycomb.io/1/signals/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Honeycomb-Team"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "hcasp_01j9x1yq0k2t8m9n3v4b5r6c7d",
  "service_name": "checkout-api",
  "dataset_slug": "checkout-api",
  "environment_slug": "production",
  "measured_signal": "error_rate",
  "enabled": true,
  "status": "active",
  "sensitivity": "medium",
  "auto_investigate": false,
  "currently_anomalous": false,
  "last_anomaly_started_at": 1741089600,
  "last_anomaly_ended_at": 1741093200,
  "created_at": "2025-02-14T17:32:11Z",
  "updated_at": "2025-03-01T10:04:22Z",
  "recipients": [
    {
      "id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
      "type": "pagerduty",
      "details": {
        "pagerduty_severity": "critical",
        "muted": false
      }
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Rate Limited"
}

{
  "error": "<string>"
}

GET

signals

{id}

Get a Signal

curl --request GET \
  --url https://api.honeycomb.io/1/signals/{id} \
  --header 'X-Honeycomb-Team: <api-key>'

const options = {method: 'GET', headers: {'X-Honeycomb-Team': '<api-key>'}};

fetch('https://api.honeycomb.io/1/signals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.honeycomb.io/1/signals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Honeycomb-Team: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.honeycomb.io/1/signals/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Honeycomb-Team", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.honeycomb.io/1/signals/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Honeycomb-Team"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "hcasp_01j9x1yq0k2t8m9n3v4b5r6c7d",
  "service_name": "checkout-api",
  "dataset_slug": "checkout-api",
  "environment_slug": "production",
  "measured_signal": "error_rate",
  "enabled": true,
  "status": "active",
  "sensitivity": "medium",
  "auto_investigate": false,
  "currently_anomalous": false,
  "last_anomaly_started_at": 1741089600,
  "last_anomaly_ended_at": 1741093200,
  "created_at": "2025-02-14T17:32:11Z",
  "updated_at": "2025-03-01T10:04:22Z",
  "recipients": [
    {
      "id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
      "type": "pagerduty",
      "details": {
        "pagerduty_severity": "critical",
        "muted": false
      }
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Rate Limited"
}

{
  "error": "<string>"
}

Authorizations

X-Honeycomb-Team

string

header

required

Authenticate using a Honeycomb Configuration Key.

Pass the Token in the X-Honeycomb-Team header:

X-Honeycomb-Team: 1234567890123456789012

If you created your key using the API, use data.attributes.secret; this is the same value as the Token in the UI.

To learn how to create a Configuration Key, visit Manage Environment API Keys. To learn more about authenticating requests, visit API Authentication.

Path Parameters

string

required

The unique identifier (ID) of a Signal.

Response

Success

A Signal with its assigned Recipients.

string

required

read-only

Unique identifier (ID) of the Signal.

Example:

"hcasp_01j9x1yq0k2t8m9n3v4b5r6c7d"

service_name

string

required

read-only

The name of the service the Signal monitors.

Example:

"checkout-api"

dataset_slug

string

required

read-only

The slug of the dataset the Signal's service reports to.

Example:

"checkout-api"

environment_slug

string

required

read-only

The slug of the environment the Signal belongs to.

Example:

"production"

measured_signal

enum<string>

required

The kind of measurement the Signal is trained on.

Available options:

error_rate,

presence

Example:

"error_rate"

enabled

boolean

required

Whether the Signal is currently enabled. Disabled Signals do not fire.

Example:

true

status

enum<string>

required

The lifecycle status of the Signal.

Available options:

onboarding,

training,

active,

false,

ineligible

Example:

"active"

sensitivity

enum<string> | null

required

How far a measurement must deviate from the trained normal band before the Signal fires. Always null for presence Signals, and null for any Signal that has not yet trained.

Available options:

low,

medium,

high

Example:

"medium"

auto_investigate

boolean

required

read-only

When true, Honeycomb will automatically start an investigation when this Signal fires.

Example:

false

currently_anomalous

boolean

required

read-only

Whether the Signal is currently in an anomalous state.

Example:

false

last_anomaly_started_at

integer | null

required

read-only

The start time of the most recent anomaly, in seconds since UNIX epoch. null when the Signal has never been anomalous.

Example:

1741089600

last_anomaly_ended_at

integer | null

required

read-only

The end time of the most recent anomaly, in seconds since UNIX epoch. null when no anomaly has ended yet, or the Signal is currently anomalous.

Example:

1741093200

created_at

string<date-time>

required

read-only

The ISO8601-formatted time when the Signal was created.

Example:

"2025-02-14T17:32:11Z"

updated_at

string<date-time>

required

read-only

The ISO8601-formatted time when the Signal was last updated.

Example:

"2025-03-01T10:04:22Z"

recipients

object[]

required

The Recipients notified when this Signal fires.

Show child attributes

Example:

[
  {
    "id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
    "type": "pagerduty",
    "details": {
      "pagerduty_severity": "critical",
      "muted": false
    }
  }
]

Getting Started

Reference

API Endpoints

Get a Signal

Authorizations

Path Parameters

Response