Create Alert

LLM-friendly URL

POST

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

API call form

Examples

Create an alert, that will be triggered if the given query returns a non-empty result set and will send an e-mail or text message, call a webhook or show a Slack message.

Scheduled alerts are in the context of the creating user, taking into account any (parameter) filters set. In case of Embed (or SSO) tokens, the alert is performed by the most recently created token for this user. This means that if the user permissions of the user evolve over time, any scheduled alerts will automatically adapt. If you want to make sure a scheduled alert always keep using the original parameter override value, however, you can mark the parameter value as sticky by setting the sticky: true flag on the parameter override of the Authorization. See Authorization Create .

Parameters

Expand all

Reset

Can be executed by:

Logged-in User

Can be associated to:

Schedule

User

Securable

Channel

Did this page help you?

Yes

Language

Shell

Node

Java

.NET

Python

PHP

Install

npm install @luzmo/nodejs-sdk

Example Request

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: "We sold more than 10000 burrito's!"
    },
    query: {
      dimensions: [
        
        {
          dataset_id: "< Burrito dataset id >",
          column_id: "< Type of burrito column id >"
        }
      ],
      measures: [
        
        {
          dataset_id: "< Burrito dataset id >",
          column_id: "< Number of burritos column id >",
          aggregation: {
            type: "sum"
          }
        }
      ],
      having: [
        
        {
          expression: "? in ?",
          parameters: [
            
            {
              dataset_id: "< Burrito dataset id >",
              column_id: "< Type of burrito column id >"
            },
            
            [
              "Quesarito",
              "Chicken baconito"
            ]
          ]
        },
        
        {
          expression: "? >= ?",
          parameters: [
            
            {
              dataset_id: "< Burrito dataset id >",
              column_id: "< Sold units column id >",
              aggregation: {
                type: "sum"
              }
            },
            10000
          ]
        }
      ]
    },
    chart_id: "< chart ID >",
    securable_id: "< securable ID >",
    frequency: {
      unit: "day",
      quantity: 1
    },
    timezone_id: "< timezone formatted like Europe/Brussels >"
  }
);

Example Response

200

400

500

{
  "id": "0218f31b-0296-4cce-b2a4-384f27d2526a",
  "name": {
    "en": "My alert"
  },
  "query": {
    "measures": [
      {
        "dataset_id": "74379a5b-4979-49b0-9fda-7b72ca5c1c77",
        "column_id": "8aaa54b3-b605-4f2b-a93f-6d6c7d017366",
        "aggregation": {
          "type": "sum"
        }
      }
    ],
    "dimensions": [
      {
        "column_id": "7d4a54b3-a805-4f2b-a93f-6d6c7d017305",
        "dataset_id": "74379a5b-4979-49b0-9fda-7b72ca5c1c77"
      }
    ],
    "where": [
      {
        "expression": "? in ?",
        "parameters": [
          {
            "dataset_id": "74379a5b-4979-49b0-9fda-7b72ca5c1c77",
            "column_id": "7d4a54b3-a805-4f2b-a93f-6d6c7d017305"
          },
          [
            "Quesarito",
            "Chicken baconito"
          ]
        ]
      }
    ],
    "having": [
      {
        "expression": "? > ?",
        "parameters": [
          {
            "dataset_id": "74379a5b-4979-49b0-9fda-7b72ca5c1c77",
            "column_id": "8aaa54b3-b605-4f2b-a93f-6d6c7d017366",
            "aggregation": {
              "type": "sum"
            }
          },
          10000
        ]
      }
    ],
    "context": {},
    "options": {
      "timezone_id": "Europe/Brussels"
    }
  },
  "chart_id": null,
  "created_at": "2024-02-09T15:20:52.350Z",
  "updated_at": "2024-02-09T15:20:52.360Z",
  "user_id": "444e2d0c-8dfb-45c1-bb97-52cb9264671f",
  "schedule_id": "845ce6b8-6371-4f80-b471-74a0ba163db6",
  "securable_id": "74379a5b-4979-49b0-9fda-7b72ca5c1c77",
  "frequency": {
    "unit": "day",
    "quantity": 1
  }
}