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
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").

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.

Maximum array length: 100