Skip to content

Latest commit

 

History

History
142 lines (85 loc) · 7.82 KB

alerts.md

File metadata and controls

142 lines (85 loc) · 7.82 KB
title redirect_from
Alerts
/docs/latest/users-guide/15-alerts
/docs/latest/questions/sharing/alerts

Alerts

Set up an alert to send the results of questions to people via email or Slack, or to a webhook.

The wide world of alerts

Alerts are for questions only. If you instead want to get the results of a dashboard sent to you, check out dashboard subscriptions.

Prerequisite for alerts

To start using alerts, an administrator will need to have set up at least one of the following notification channels.

Creating an alert

To create an alert:

  1. Save your question
  2. Click on the sharing icon in the top-right of the screen
  3. Select Create alert.

Get alerts

Available types of alerts will depend on the visualization you selected.

Types of alerts

There are three kinds of things you can get alerted about in Metabase:

Goal line alerts

Requires a bar, line, or area chart with a goal line.

Goal line alerts are useful when you're doing things like tracking daily active users (DAU) and you want to know when you reach a certain number of DAU, or when you're tracking orders per week and you want to know whenever the number of orders ever goes below a certain threshold.

To start, you'll need a line, area, or bar chart displaying a number over time.

Next, you need to set up a goal line on your chart. Open up the visualization settings by clicking the gear icon in the bottom-left. Then click on the Display tab, and turn on the Show goal setting. Choose a value for your goal (and optionally a label) and click Done.

You can choose:

  • Whether you want Metabase to alert you when the time series goes above the goal line or when it goes below the goal line.
  • Whether you want Metabase to alert you every time the time series crosses a goal line, or only the first time it crosses the goal line.
  • How often you want Metabase to check to see if the goal line has been crossed.

Goal line alert options

Click Done, and your alert will be all set up! You'll get an email confirmation, too. If you need to edit or unsubscribe from the alert you set up, just click that same icon. You'll see the Edit and Unsubscribe buttons. This is also where you'll see alerts about this question that administrators might have added you to.

Progress bar alerts

Requires the progress bar visualization.

If you want to set up an alert when a single number reaches a goal, you can use a progress bar visualization.

  1. Create a question that returns a single number as its result,
  2. Choose the Progress Bar chart type,
  3. In Visualization settings, select a goal value
  4. Save your question,
  5. Create an alert by clicking on the Sharing icon in top right

You'll see the options for when you want to get alerts about this progress bar:

  • Whether to alert when the progress bar reaches the goal line or below the goal,
  • Whether to alert only the first time the progress bar reaches the goal line, or every time
  • How often you want Metabase to check to see if the goal has been reached.

Results alerts

Lastly, you can get an alert when one of your saved questions returns any result. This kind of alert is the most useful if you have a question that doesn't usually return any results, but you just want to know when it does return results.

For example, you might have a table called Reviews, and you want to know any time a customer leaves a bad review, which you consider to be anything below three stars. To set up an alert for this situation, you'd go and create a raw data question (i.e., a question that returns a list of reviews), and add a filter to only include results with fewer than three stars.

You probably don't want to be alerted about all the bad reviews you've ever gotten, but just recent ones. So you can add a filter to only include results from yesterday or today, depending on how often you want to check for these bad reviews. At this point, when you check the results of this question, it probably won't return any results, which is a good thing.

Save the question, create an alert, and select how often you want Metabase to check this question for results. That's it!

Editing and deleting alerts

To edit or delete alerts on a question, click on the Sharing icon in the top right corner.

You'll be able to edit alerts that you set up. Admins get additional special privileges with alerts.

Everyone

  • Everyone can edit alerts that they've personally set up (but not alerts set up by other people).
  • Everyone can view and unsubscribe from all alerts they receive by clicking on the gear icon in the upper right and navigating to Account settings > Notifications.

Admins

  • Admins can edit and delete any alert. This can't be undone, so be careful!
  • Admins can add or remove recipients on any alert, even ones that they did not create themselves.
  • Admins can remove all alerts created by a Metabase user and unsubscribe that user from all other alerts from the People menu in Admin settings.

Avoid changing the name of the alerted channel in Slack

Once you set up an alert to a Slack channel, avoid changing the name of that channel in Slack. If you rename the channel in Slack, but you want Metabase to continue to send alerts to that renamed channel, you'll need to update the alert in Metabase to point to the new channel name.

Alert expiration

Some circumstances will automatically delete alerts:

  • Renaming the alerted channel in Slack. Well, technically the alert won't get deleted, but Metabase will no longer have anywhere to send the alerts to. You'll need to update the alert's target channel in Metabase to the new channel's name.
  • If a saved question that has an alert gets edited in such a way that the alert doesn't make sense anymore, the alert will get deleted. For example, if a saved question with a goal line alert on it gets edited, and the goal line is removed entirely, Metabase will delete the alert.
  • If a question is deleted, Metabase will delete any alerts set up for that question.

Alerts will continue to work even if the person who set up the alert no longer has an active account. For example, if an alert with multiple recipients (or to a Slack channel) was set up by someone whose account has since been deactivated, that alert will continue to work (though Metabase will stop sending the alerts to the deactivated account).

Admins can see all alerts

{% include plans-blockquote.html feature="Usage analytics" %}

Admins can view a list of all alerts and dashboard subscriptions that people have set up in your Metabase in the Usage analytics collection. See Usage analytics.

How permissions work with alerts

See Notification permissions.

Sending alerts to private Slack channels

See Sending alerts and subscriptions to private Slack channels.

Further reading