Create an alert rule

Creates a new alert rule. The request body must be a JSON-encoded alert rule object that follows the CreateAlertRuleRequest schema.

POST /v1/platform/alerts/{session_id}

Error

A valid request URL is required to generate request examples

201

{
  "actions": [
    {
      "config": {},
      "alert_rule_id": "<string>",
      "created_at": "<string>",
      "id": "<string>",
      "updated_at": "<string>"
    }
  ],
  "rule": {
    "description": "<string>",
    "name": "<string>",
    "window_minutes": 30,
    "created_at": "<string>",
    "denominator_filter": "<string>",
    "filter": "<string>",
    "id": "<string>",
    "session_id": "<string>",
    "session_name": "<string>",
    "threshold": 123,
    "threshold_multiplier": 123,
    "threshold_window_minutes": 59,
    "updated_at": "<string>"
  }
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

session_id · string · required

Session ID

Body

application/json

actions · object[] · required

Show child attributes

rule · object · required

Show child attributes

Response

201

application/json

Alert rule created

actions · object[]

Show child attributes

rule · object

Show child attributes