Create Alert

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/alert

API call form

Examples

List of examples

Create an alert
Create an alert and define channel
Create alert & associate to existing Channel

Description

Create an alert and at the same time also define the channel through which the alert will be sent. Omit the chart and dashboard id if you do not want to alert to be linked to a specific chart.

Install

pkg:maven/com.luzmo/sdk@1.0.0

Example Request

Shell

Node

Java

.NET

Python

PHP

Luzmo client = new Luzmo(
  "<your Luzmo API key>",
  "<your Luzmo API token>",
  "https://api.luzmo.com"
);


JSONObject response = client.create("alert",
  ImmutableMap.of(
    "name" , ImmutableMap.of(
      "en" , "We sold more than 10000 burrito's of type Quesarito!"
    ),
    "query" , ImmutableMap.of(
      "dimensions" , ImmutableList.of(
        ImmutableMap.of(
          "dataset_id" , "< Burrito dataset id >",
          "column_id" , "< Type of burrito column id >"
        )
      ),
      "measures" , ImmutableList.of(
        ImmutableMap.of(
          "dataset_id" , "< Burrito dataset id >",
          "column_id" , "< Number of burritos column id >",
          "aggregation" , ImmutableMap.of(
            "type" , "sum"
          )
        )
      ),
      "having" , ImmutableList.of(
        ImmutableMap.of(
          "expression" , "? in ?",
          "parameters" , ImmutableList.of(
            ImmutableMap.of(
              "dataset_id" , "< Burrito dataset id >",
              "column_id" , "< Type of burrito column id >"
            ),
            ImmutableList.of(
              "Quesarito"
            )
          )
        ),
        ImmutableMap.of(
          "expression" , "? > ?",
          "parameters" , ImmutableList.of(
            ImmutableMap.of(
              "dataset_id" , "< Burrito dataset id >",
              "column_id" , "< Number of burritos column id >",
              "aggregation" , ImmutableMap.of(
                "type" , "sum"
              )
            ),
            10000
          )
        )
      )
    ),
    "chart_id" , "< chart ID >",
    "securable_id" , "< securable ID >",
    "frequency" , ImmutableMap.of(
      "unit" , "day",
      "quantity" , 1
    ),
    "timezone_id" , "< timezone formatted like Europe/Brussels >",
    "channels" , ImmutableList.of(
      ImmutableMap.of(
        "type" , "email",
        "config" , ImmutableMap.of(
          "recipients" , ImmutableList.of(
            ImmutableMap.of(
              "address" , "user@organization.com",
              "type" , "to",
              "locale" , "en"
            )
          ),
          "subject" , ImmutableMap.of(
            "en" , "Great sales!"
          ),
          "message" , ImmutableMap.of(
            "en" , "We've done great boys! Check out these numbers!"
          )
        )
      )
    )
  )
);