Skip to main content
GET
List a monitor's alert rules
You are reading the docs of Galtea 5.11. Read this page in the latest version.

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

monitorId
string
required

Monitor ID

Example:

"monitor_123"

Response

Alert rules retrieved successfully

id
string
required
Example:

"monitorAlertRule_123"

monitorId
string
required
Example:

"monitor_123"

type
enum<string>
required
Available options:
BAD_SESSION_COUNT,
NO_SCORE_RATE,
AVERAGE_SCORE
Example:

"BAD_SESSION_COUNT"

metricGroupId
string | null
required

The metric family the rule watches; null for a rule that watches a Specification

Example:

"metricGroup_123"

specificationId
string | null
required

The Specification the rule watches; null for a rule that watches a metric family

Example:

null

window
enum<string>
required
Available options:
FIFTEEN_MINUTES,
ONE_HOUR,
SIX_HOURS,
TWENTY_FOUR_HOURS
Example:

"ONE_HOUR"

badSessionScore
number | null
required
Example:

0.5

threshold
number
required
Example:

3

recipients
string[]
required
Example:
webhookUrlHost
string | null
required

The host and port of the webhook URL, such as hooks.slack.com or hooks.example.com:8443 (the port shows only when it is not the default); null when the rule has none. The URL is never returned.

Example:

"hooks.slack.com"

userId
string | null
required
Example:

"user_123"

createdAt
string<date-time>
required
pausedAt
string<date-time> | null
required

When the rule was paused; null while it is active

Example:

null

readiness
object | null
required

How close the rule is to deciding. Null for a rule whose window is never too small (BAD_SESSION_COUNT), and when the count could not be read right now. While isEvaluating is false, the rule opens and closes nothing. isEvaluating is also false while the rule is paused.