Skip to main content
GET
List alert rule types

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Response

Alert rule types, ordered by ruleType.

Maximum array length: 100
ruleType
enum<string>
required

Identifies the type; this is what a rule of this type stores in ruleType.

Available options:
login_success_rate,
relative_flow_count,
relative_subflow_count,
absolute_flow_count
valueFormat
object
required

How the values and thresholds of a rule type are written for people. Values and thresholds stay raw numbers in every response; apply this to display them.

vocabulary
object
required

What the numbers and settings of a rule type are called, so every place that shows them names them the same way. A type with variants names them by the variant a rule picks ("Logins counted"), with the same term keys for every variant. What depends on other settings or on one evaluation, such as the length of the window, is not part of a term.

label
string
required

Human-readable name of the type, for the type picker.

measures
string
required

What the type measures, as a short phrase (e.g. "completed logins / engaged logins").

description
string
required

One sentence on how a rule of this type works, for the rule builder.

available
boolean
required

Whether this project has the data this type reads. Rules of an unavailable type cannot be saved.

dimensions
object[]
required

Keys a rule of this type can be grouped by for this project. Empty when available is false, and empty for a type with variants: there each variant lists its own.

Maximum array length: 100
variants
object[]
required

The choices a rule of this type makes in its settings that decide what it reads, for relative_flow_count and absolute_flow_count the flowType, for relative_subflow_count the subflowType. Only choices this project can be evaluated for are listed. Empty for a type without variants.

Maximum array length: 1000