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 which, when triggered, should be sent from an already existing Channel. omit the chart id and securable id if the alert should not be linked to a specific chart.

Install

npm install @luzmo/nodejs-sdk

Example Request

Shell

Node

Java

.NET

Python

PHP

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.create('alert',
  {
    name: {
      en: "My new alert"
    },
    frequency: {
      unit: "day",
      quantity: 1
    },
    chart_id: "<chart_id>",
    securable_id: "<dashboard_id>",
    query: {
      measures: [
        {
          dataset_id: "<dataset_id>",
          column_id: "<column_id>",
          aggregation: {
            type: "sum"
          }
        }
      ],
      having: [
        {
          expression: "? > ?",
          parameters: [
            {
              dataset_id: "<dataset_id>",
              column_id: "<column_id>",
              aggregation: {
                type: "sum"
              }
            },
            10
          ]
        }
      ]
    }
  }
);