Skip to main content
GET
Get a metric alarm

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
alarm_id
string
required

Response

The alarm

channels
object[]
required
comparison
enum<string>
required
Available options:
gt,
gte,
lt,
lte
datapoints_to_alarm
integer<int32>
required
dims
object
required

Metric dimension filters. Omitted = aggregate across that dimension.

Not Copy since label is owned.

enabled
boolean
required
evaluation_periods
integer<int32>
required
id
integer<int64>
required
metric_name
string
required
min_sample_count
integer<int64>
required
missing_data
enum<string>
required
Available options:
not_breaching,
breaching,
insufficient,
ignore
name
string
required
period_seconds
integer<int32>
required
stat
string
required

Aggregation applied to each evaluation period. Percentiles run from p0.1 to p99.9 in tenths; equivalent spellings such as p95.0 are accepted and returned canonically as p95, while a finer value such as p95.05 is rejected rather than rounded. They are exact rather than interpolated from bins, so they are only available on app.run.duration_ms and cannot be used with denominator_metric_name.

Pattern: ^(avg|sum|count|min|max|p\d+(\.\d+)?)$
Example:

"p99"

state
enum<string>
required
Available options:
ok,
alarm,
insufficient_data
threshold
number<double>
required
clear_threshold
number<double> | null

Set when this alarm uses hysteresis; see [CreateAlarmReq].

denominator_metric_name
string | null

Set when this is a ratio alarm; see [CreateAlarmReq].

project_id
integer<int64> | null

Project this alarm belongs to; omitted for org-level alarms.

state_changed_at
string<date-time> | null