Skip to content
Snippets Groups Projects
Unverified Commit 0aa8ec88 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - update images (#21797)

parent 8164cf04
No related merge requests found
Showing
with 46 additions and 65 deletions
......@@ -38,7 +38,7 @@ This is the query builder's notebook editor. It has three default steps.
- [Summarizing and grouping by](#summarizing-and-grouping-by)
To the right of completed step is a **Preview** button (looks like a Play button - a triangle pointing to the right) that shows you the first 10 rows of the results of your question up to that step.
![Previewing results](./images/notebook/preview-table.png)
## Picking data
......@@ -65,7 +65,7 @@ Broadly speaking, there are three types of columns, each with their own set of f
You can add subsequent filter steps after every summarize step. This lets you do things like summarize by the count of rows per month, and then add a filter on the `count` column to only include rows where the count is greater than 100. (This is basically like a SQL `HAVING` clause.)
Once you're happy with your filter, click **Add filter**, and visualize your results. Your data will be updated with the filter applied.
Once you're happy with your filter, click **Add filter**, and visualize your results. Your data will be updated with the filter applied.
![An active filter](./images/notebook/filter-badge.png)
......@@ -175,7 +175,7 @@ Custom expressions allow you to use spreadsheet-like functions and simple arithm
Custom columns are helpful when you need to create a new column based on a calculation, such as subtracting the value of one column from another, or extracting a portion of an existing text column. Custom columns that you add aren't permanently added to your table; they'll only be present in the given question.
You can use the following math operators in your formulas: `+`, `–`, `*` (multiplication), and `/` (division), along with a whole host of spreadsheet-like functions. You can also use parentheses to clarify the order of operations.
You can use the following math operators in your formulas: `+`, `–`, `*` (multiplication), and `/` (division), along with a whole host of spreadsheet-like functions. You can also use parentheses to clarify the order of operations.
## Sorting results
......@@ -199,14 +199,11 @@ Each time you start modifying a saved question, Metabase will create a new quest
Feel free to play around with any saved question, as you won't have any effect on the existing question. When you hit **Save** on the question, you can choose either to save as a new question (the default), or you can overwrite the existing question you started from.
![The graphical query builder](./images/asking-questions/simple-mode.png)
If you find yourself using the same saved question as a starting point for multiple questions, you may want to turn it into a [Model][model] to let others know it's a good starting place.
---
## Next: Visualizing results
## Further reading
Next, we'll learn how to [visualize results](05-visualizing-results.md).
- [Visualize results](05-visualizing-results.md).
- [Asking questions](/learn/questions)
[model]: models.md
......@@ -47,13 +47,11 @@ The **Numbers** option is for displaying a single number, nice and big. The opti
### Trends
The **Trend** visualization is great for displaying how a single number has changed over time. To use this visualization, you'll need to have a single number grouped by a Time field, like the Count of Orders by Created At. The Trend will show you the value of the number during the most recent period, as well as how much the number has increased or decreased compared to its value in the previous period. The period is determined by your group-by field; if you're grouping by Day, the Trend will show you the most recent day compared to the day before that.
![Trend](images/visualizations/trend.png)
![Trend settings](images/visualizations/trend-settings.png)
By default, Trends will display increases as green (i.e. "good") and decreases as red ("bad"). If your number is something where an increase is bad and a decrease is good (such as Bounce Rate, or Costs), you can reverse this behavior in the visualization settings:
The **Trend** visualization is great for displaying how a single number has changed over time. To use this visualization, you'll need to have a single number grouped by a Time field, like the Count of Orders by Created At. The Trend will show you the value of the number during the most recent period, as well as how much the number has increased or decreased compared to its value in the previous period. The period is determined by your group-by field; if you're grouping by Day, the Trend will show you the most recent day compared to the day before that.
![Trend settings](images/visualizations/trend-settings.png)
By default, Trends will display increases as green (i.e. "good") and decreases as red ("bad"). If your number is something where an increase is bad and a decrease is good (such as Bounce Rate, or Costs), you can reverse this behavior in the visualization settings.
### Progress bars
......@@ -77,8 +75,6 @@ The **Table** option is good for looking at tabular data (duh), or for lists of
#### Rearranging, adding, and removing columns
![Additional fields](images/visualizations/add-fields.png)
Open up the settings for your table and you'll see the Columns tab, which displays all the columns currently being shown in the table. Below that you'll see a list of more columns from linked tables, if any, that you can add to the current table view.
To hide a column, click the X icon on it; that'll send it down to the **More columns** area in case you want to bring it back. To add a linked column, just click the + icon on it, which will bring it to the **Visible columns** section. Click and drag any of the columns listed there to rearrange the order in which they appear. Another super easy way to rearrange columns without having to open up the visualization settings is to simply click and drag on a column's heading to move it where you'd like it to go.
......@@ -156,7 +152,7 @@ Pivot tables are not currently available for the following databases in Metabase
- Google Analytics
- MongoDB
Pivot tables work for simple and custom questions with summarized data for all other [officially supported databases](../administration-guide/01-managing-databases.md#officially-supported-databases). They don't work for questions that lack aggregate data, and they don't work for questions written in SQL, as Metabase would need to modify your SQL code in order to calculate subtotals. If you really need to use SQL, the workaround here is to create your question in two steps: first do all the complex things you need to do in SQL, save the results as a question, then use that saved SQL question as the starting point for a new GUI question which summarizes that data.
Pivot tables work for simple and custom questions with summarized data for all other [officially supported databases](../administration-guide/01-managing-databases.md#officially-supported-databases). They don't work for questions that lack aggregate data, and they don't work for questions written in SQL, as Metabase would need to modify your SQL code in order to calculate subtotals. If you really need to use SQL, the workaround here is to create your question in two steps: first do all the complex things you need to do in SQL, save the results as a question, then use that saved SQL question as the starting point for a new GUI question which summarizes that data.
In the settings for the Pivot Table visualization, you can assign fields to one of three "buckets":
......
......@@ -6,7 +6,7 @@ Whenever you’ve arrived at an answer that you want to save for later, click th
![Save button](images/sharing-answers/save-button.png)
A pop-up box will appear, prompting you to give your question a name and description, and to pick which [collection][collections] to save it in. Note that your administrator might have set things up so that you're only allowed to [save questions in certain collection][collection-permissions], but you can always save things in your Personal Collection. After saving your question, you'll be asked if you want to add it to a new or existing dashboard.
A modal will appear, prompting you to give your question a name and description, and to pick which [collection][collections] to save it in. Note that your administrator might have set things up so that you're only allowed to [save questions in certain collection][collection-permissions], but you can always save things in your Personal Collection. After saving your question, you'll be asked if you want to add it to a new or existing dashboard.
Now, whenever you want to refer to your question again you can find it by searching for it in the search bar at the top of Metabase, or by navigating to the collection where you saved it.
......@@ -25,8 +25,10 @@ Once you save your question, a down arrow will appear to the right of the questi
- **Edit details** (Pencil icon). Change the title of the question, and add some description for context. Adding a description will also make the question easier to find using the search bar. You can also select more options to [cache the results of the question](#caching-results).
- **Add to dashbboard** (Dashboard icon with plus symbol). See [dashboards][dashboards].
- **Move** (Document icon with right arrow). Relocate the question to a different [collection][collections].
- **Turn this into a model**. See [Models](models.md).
- **Duplicate** (Square with little square). Create a copy of the question. Keep in mind that whenever you start editing a saved question, Metabase will create a copy of the question. You can either save your edits as a new question, or overwrite the original saved question.
- **Archive** (Folder with down arrow). See [Archiving items][archiving-items].
- **Bookmark** Save the question as a favorite, which will show up in the bookmarks section of your navigation sidebar. See [Bookmarks](03-basic-exploration.md#bookmarks).
### Caching results
......
......@@ -12,7 +12,7 @@ To add a filter to a dashboard, first click the **pencil icon** to enter dashboa
![Add a Filter](images/dashboard-filters/01-add-filter.png)
You can choose from a number of filter types:
You can choose from a number of filter types:
- [Time](#time-filters)
- [Location](#location-filters)
......@@ -37,7 +37,7 @@ Single Date and Date Range will provide a calendar widget, while the other optio
#### Location filters
There are four types of Location filters to choose from:
- City
- State
- ZIP or Postal Code
......@@ -59,7 +59,7 @@ Let's add a filter widget to our dashboard. We'll select a **Time** filter, and
![Choose filter type](images/dashboard-filters/02-filter-type.png)
Metabase will display a filter editing interface where you can wire up your new filter to each applicable card.
Metabase will display a filter editing interface where you can wire up your new filter to each applicable card.
![Wiring up the cards](images/dashboard-filters/03-wiring-cards.png)
......@@ -78,11 +78,11 @@ When you're finished wiring up the filter, click **Done** at the bottom of the s
- **To edit a filter**: click the **pencil** icon to enter dashboard editing mode, then click the **gears** icon button on the filter you want to change. You can wire up individual cards to the filter, and use the sidebar to update the label.
- **To reorder your filters**: click on the grabber handle on the left side of a filter, then drag the filter to a different position.
- **To set a default value**: click on the filter's **gears** icon to open the filter sidebar. Under the **Settings** tab, enter a value in the **Default value** input field.
- **To remove a filter**: click on the filter's **gears** icon to open the filter sidebar. Under the **Settings** tab, click **Remove** in the sidebar. If you accidentally remove a filter, just click **Cancel** in the top-right to exit dashboard editing mode without saving your changes.
- **To remove a filter**: click on the filter's **gears** icon to open the filter sidebar. Under the **Settings** tab, click **Remove** in the sidebar. If you accidentally remove a filter, just click **Cancel** in the top-right to exit dashboard editing mode without saving your changes.
### Using filters
Once you’ve added a filter to your dashboard, just click on the filter to select a value and activate the filter. To stop filtering, just click the blue X.
Once you’ve added a filter to your dashboard, just click on the filter to select a value and activate the filter. To stop filtering, just click the blue X.
![Using a filter](images/dashboard-filters/08-use-filter.png)
......@@ -112,7 +112,7 @@ You can also **link filters** so that a child filter knows to limit its choices
Say you have two filters, one to filter by state, the other to filter by city. You can link the city filter to the state filter so that when someone filters by California, the city filter will "know" to only show cities in California. In this case, state is the parent filter, and city is the child filter.
To link filters, you'll need to set up this parent-child relationship. And you set up this relationship through the child filter. In the above scenario, with a state and city filter, we'd edit the child filter, city, by clicking on the **gears** icon on the city filter. From the filter sidebar on the right, select the **Linked filters** tab.
To link filters, you'll need to set up this parent-child relationship. And you set up this relationship through the child filter. In the above scenario, with a state and city filter, we'd edit the child filter, city, by clicking on the **gears** icon on the city filter. From the filter sidebar on the right, select the **Linked filters** tab.
![Linked filters](images/dashboard-filters/linked-filter.png)
......@@ -128,8 +128,8 @@ Here are a few tips to get the most out of dashboard filters:
- **Start with a new dashboard**. While you can add dashboard filters to an existing dashboard with a bunch of cards in it, it can be easier to start a new dashboard and think about what filters you intend to add to it. That way you can make sure that you only put cards in that dashboard that can be used with the filters. Alternatively, you could duplicate an existing dashboard, and pare down the number of cards.
- **Link filters** so people don't have to sift through irrelevant filter options (like cities not in a filtered state).
---
## Next: Interactive dashboards
## Further reading
We'll learn how to [make our dashboards interactive](interactive-dashboards.md).
- [Dashboards intro](07-dashboards.md)
- [Interactive dashboards](interactive-dashboards.md)
- [Learn dashboards](/learn/dashboards)
## Charts with multiple series
# Charts with multiple series
Data in isolation is rarely all that useful. One of the best ways to add context and clarity when communicating with data is to show data side-by-side with other data. Here are just a few examples of data that is better together than apart.
......@@ -7,7 +7,7 @@ Data in isolation is rarely all that useful. One of the best ways to add context
- New users per day vs. returning users per day.
- Orders per day from a few different product lines.
### Displaying data side by side
## Displaying data side by side
There are two main ways to visualize data side by side:
......@@ -15,7 +15,7 @@ There are two main ways to visualize data side by side:
2. [**Combine two saved questions**](#combining-two-saved-questions) that share a common dimension (like time) on a dashboard. For example, you could look at revenue over time and costs over time together.
### Ask a question that involves multiple dimensions
## Ask a question that involves multiple dimensions
If you’re creating a new question, you can view the results as a multi-series visualization by summarizing your data and grouping it into two groups.
......@@ -33,8 +33,7 @@ You can also create a multi-series chart by composing a custom question in the n
Note: you won’t be able to add another saved question to multi-series visualizations made in this fashion. Metabase can visualize up to 100 distinct values of a dimension at once, so if you're selecting a field that contains a lot of values, you might need to filter the values.
### Combining two saved questions
## Combining two saved questions
If you already have two or more saved questions you’d like to compare, and they share a dimension, they can be combined on any dashboard. Here’s how:
......@@ -58,19 +57,17 @@ Once you have your chart looking how you’d like, hit done. Metabase will show
> **SQL questions may not work**. Metabase has less information about SQL-based questions, so we cannot guarantee they can be added reliably. You'll see a little warning sign next to SQL questions to indicate this uncertainty, so be aware that adding these kinds of questions may not work.
### Combining Number charts
## Combining Number charts
If you need to compare single numbers to get a sense of how they differ, Metabase can turn multiple number charts into a bar chart.
As above, while editing a dashboard, hover over a number chart of your choice, and click on the icon with the **+** and bar chart icon to add a saved question.
![Add bar chart](images/multi-series-charts/add_bar_chart.png)
Use the search bar to find other saved question(s) that you’d like to see represented on the bar chart, and click the checkbox to add them to your chart. In this case, we added **Widget orders** to compare them to **Gadget orders**.
![From numbers to bar chart](images/multi-series-charts/numbers_to_bar_chart.png)
### Multi-series charts, values, and legibility
## Multi-series charts, values, and legibility
When displaying multiple series, it’s important to keep legibility in mind. Combining many series can sometimes decrease the communication value of the data.
......@@ -78,9 +75,11 @@ Metabase allows you to add values to multi-series charts, but go easy on this fe
From the **Visualization -> Display** options, you can toggle the option: **Show values on data points**. Metabase will do its best to fit as many values as can fit nicely. You can also force Metabase to (begrudgingly) show values for all data points, by setting the **Values to show** to **All**.
![add values to multi-series chart](images/multi-series-charts/add_values.gif)
You can also toggle values for each individual series. If you have three series, for example, you can show values on one, two, or all three series. In the **Display** tab, click on the down arrow to the right of a series to expand its details, and toggle **Show values for this series** to show or hide its values.
![add values to multi-series chart](images/multi-series-charts/add_values.png)
You can also toggle values for each individual series. If you have three series, for example, you can show values on one, two, or all three series. In the **Display** tab, click on the down arrow to the right of a series to expand its details, and toggle **Show values for this series** to show or hide its values. You can also toggle values for the whole chart, then selectively hide values for individual series until you have your chart looking just right.
You can also toggle values for the whole chart, then selectively hide values for individual series until you have your chart looking just right.
Additionally, there is an option to configure the formatting of the values:
......@@ -88,12 +87,8 @@ Additionally, there is an option to configure the formatting of the values:
- **Compact**. Metabase abbreviates values, e.g., 1,000 becomes 1K.
- **Full**. Values are displayed in their natural beauty.
To learn more about how to create multi-series charts, check out our article on [time series comparisons](https://www.metabase.com/blog/Time-Series-Comparisons/index.html).
Now go forth and start letting your data get to know each other!
---
## Next: Dashboard subscriptions
## Further reading
Set up a dashboard to send updates via email or Slack with [dashboard subscriptions](dashboard-subscriptions.md).
- [Time series comparisons](https://www.metabase.com/blog/Time-Series-Comparisons/index.html).
## Getting alerts about questions
# Getting alerts about questions
Whether you're keeping track of revenue, users, or negative reviews, there are often times when you want to be alerted about something. Metabase has a few different kinds of alerts you can set up, and you can choose to be notified via email or Slack.
### Getting alerts
## Getting alerts
To start using alerts, someone on your team who's an administrator will need to make sure that [email integration](../administration-guide/02-setting-up-email.md) is set up first.
To start using alerts, someone on your team who's an administrator will need to make sure that [email integration](../administration-guide/02-setting-up-email.md) or Slack is set up first.
### Types of alerts
## Types of alerts
There are three kinds of things you can get alerted about in Metabase:
......@@ -16,7 +16,7 @@ There are three kinds of things you can get alerted about in Metabase:
We'll go through these one by one.
### Goal line alerts
## Goal line alerts
This kind of alert is useful when you're doing things like tracking daily active users and you want to know when you reach a certain number of them, or when you're tracking orders per week and you want to know whenever that number ever goes below a certain threshold.
......@@ -38,27 +38,23 @@ This is where you'll get to choose a few things:
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.
![Edit menu](./images/alerts/edit-menu.png)
### Progress bar alerts
## Progress bar alerts
Setting up this kind of alert is really similar to setting up a goal line alert. First, create a question that returns a single number as its result, then choose the Progress Bar chart type from the Visualization menu. Open the settings menu to select a goal value, click Done, then save your question.
Next, click the bell icon in the bottom-right and you'll see that same screen of options for when you want to get alerts about this progress bar.
### Results alerts
## 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_. 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 one or two stars.
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.
![Bad reviews](./images/alerts/bad-reviews.png)
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 one or two 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.
![No results](./images/alerts/no-results.png)
Save the question, the click on the bell icon in the bottom-right of the screen, and select how often you want Metabase to check this question for results. That's it!
### Adding additional recipients to your alerts
## Adding additional recipients to your alerts
If you're an administrator of your Metabase instance, you'll be able to see and edit every alert on all saved questions. You'll also see some additional options to add recipients to alerts, which look like this:
......@@ -68,7 +64,7 @@ You can add any Metabase user, email address, or even a Slack channel as a recip
Here's more information about [setting up email integration](../administration-guide/02-setting-up-email.md) and [setting up Slack integration](../administration-guide/09-setting-up-slack.md).
### Stopping alerts
## Stopping alerts
There are a few ways alerts can be stopped:
......@@ -77,8 +73,3 @@ There are a few ways alerts can be stopped:
- If a saved question that has an alert on it 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, that alert will get deleted.
- If a question gets archived, any alerts on it will be deleted.
---
## That's it!
If you still have questions about using alerts, you can head over to our [discussion forum](https://discourse.metabase.com/). See you there!
docs/users-guide/images/DataReference.png

121 KiB | W: | H:

docs/users-guide/images/DataReference.png

166 KiB | W: | H:

docs/users-guide/images/DataReference.png
docs/users-guide/images/DataReference.png
docs/users-guide/images/DataReference.png
docs/users-guide/images/DataReference.png
  • 2-up
  • Swipe
  • Onion skin
docs/users-guide/images/DataTableExplore.png

13.9 KiB

docs/users-guide/images/SQLButton.png

382 B

docs/users-guide/images/SaveCard.png

24.9 KiB

docs/users-guide/images/SavedQuestion.png

5.24 KiB

docs/users-guide/images/VisualizeChoices.png

131 KiB | W: | H:

docs/users-guide/images/VisualizeChoices.png

189 KiB | W: | H:

docs/users-guide/images/VisualizeChoices.png
docs/users-guide/images/VisualizeChoices.png
docs/users-guide/images/VisualizeChoices.png
docs/users-guide/images/VisualizeChoices.png
  • 2-up
  • Swipe
  • Onion skin
docs/users-guide/images/alerts/bad-reviews.png

78.1 KiB

docs/users-guide/images/alerts/edit-menu.png

5.15 KiB

docs/users-guide/images/alerts/no-results.png

29.3 KiB

docs/users-guide/images/asking-questions/show-editor.png

57.3 KiB | W: | H:

docs/users-guide/images/asking-questions/show-editor.png

57 KiB | W: | H:

docs/users-guide/images/asking-questions/show-editor.png
docs/users-guide/images/asking-questions/show-editor.png
docs/users-guide/images/asking-questions/show-editor.png
docs/users-guide/images/asking-questions/show-editor.png
  • 2-up
  • Swipe
  • Onion skin
docs/users-guide/images/asking-questions/simple-mode.png

451 KiB

docs/users-guide/images/collection-detail.png

73.8 KiB | W: | H:

docs/users-guide/images/collection-detail.png

202 KiB | W: | H:

docs/users-guide/images/collection-detail.png
docs/users-guide/images/collection-detail.png
docs/users-guide/images/collection-detail.png
docs/users-guide/images/collection-detail.png
  • 2-up
  • Swipe
  • Onion skin
docs/users-guide/images/create-menu.png

14.7 KiB

docs/users-guide/images/metabase-homepage.png

35.3 KiB | W: | H:

docs/users-guide/images/metabase-homepage.png

280 KiB | W: | H:

docs/users-guide/images/metabase-homepage.png
docs/users-guide/images/metabase-homepage.png
docs/users-guide/images/metabase-homepage.png
docs/users-guide/images/metabase-homepage.png
  • 2-up
  • Swipe
  • Onion skin
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment