Sign in
Alerts

Create Topline Alert

post/console/v1/alerts

Request body

namestring required

Name of the alert (4-100 characters)

messagestring

Alert message shown when the alert fires

teamIDstring

ID of the team that owns this alert

formulastring

Formula expression combining the alert metrics

definitionMetricsJsonstring[]

JSON-encoded metric definitions evaluated by the alert. Each entry is a stringified ToplineAlertMExDefinitionOrUnresolved.

Response

Create Alert success response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "data": {
    "owner": {
      "ownerID": "user123",
      "ownerType": "USER",
      "ownerName": "John Doe",
      "ownerEmail": "owner123@test.com"
    }
  }
}

Changes

Changed in 1 of the 8 revisions of this API.1

  • b017330dd7f71See the full diff
    • ○

      added the required property allOf[subschema #2]/data/subscribers to the response with the 201 status

      response-required-property-added