Dashboards
Last updated
Last updated
Dashboards are where TONalytica's content lives and gets discovered.
Dashboards on TONalytica consist of widgets. Widgets can either be Visualizations or a text boxes. It is also possible to embed images/GIFs inside of the text box.
You can freely resize every widget to match the layout you want to create.
You can create a new Dashboard by navigating to the main page and clicking on the “Create -> Dashboard" button.
The initial name that you give to your Dashboard will also be the URL slug. You can't change the URL slug afterward, so be mindful of the name you choose. Changing the Dashboard's display name is always possible though.
You can simply add Visualizations to your Dashboard by going into the editor mode and clicking on the corresponding button. To go into editor mode first open one of your own Dashboards and click on the edit button on the top right.
After naming your dashboard, you can add widgets from existing query visualizations or by writing commentary with a text box. Start by clicking the Add Widget button.
Text boxes support a subset of markdown. You can manipulate text and embed images and GIFs.
This is a short list of markdown syntax.
You can arrange the different widgets on the Dashboard in whatever way you like. Widgets will always try to move upwards, so if you want to create a visual divider section in your Dashboard it is advised to create a big text box as a divider.
When you create a dashboard, TONalytica automatically assigns it an id
number and a URL slug
. The slug is based on the name of the dashboard. For example, a dashboard named “Account Overview” could have this URL:
https://tonalytica.redoubt.online/dashboards/251-account-overview
If you change the dashboard name to “Account Over (Old)”, the URL will update to:
https://tonalytica.redoubt.online/dashboards/251-account-overview-old-
The dashboard can also be reached using the /dashboard
endpoint (notice this is singular), which accepts either an ID or a slug:
https://tonalytica.redoubt.online/dashboard/251
https://tonalytica.redoubt.online/dashboard/account-overview
Dashboard ids are guaranteed to be unique. But multiple dashboards may use the same name (and therefore slug
). If a user visits /dashboard/account-overview
and more than one dashboard exists with that slug, they will be redirected to the earliest created dashboard with that slug.
When queries have filters you need to apply filters at the dashboard level as well. Setting your dashboard filters flag will cause the filter to be applied to all Queries.
1. Open dashboard settings:
2. Check the “Use Dashboard Level Filters” checkbox:
Even large dashboards should load quickly because they fetch their data from a cache that renews whenever a query runs. But if you haven’t run the queries recently, your dashboard might be stale. It could even mix old data with new if some queries ran more recently than others.
To force a refresh, click the Refresh button on the upper-right of the dashboard editor. This runs all the dashboard queries and updates its visualizations.
If you want this to happen periodically you can activate Automatic Dashboard Refresh from the UI by clicking the dropdown pictured below. Or you can pass a refresh
query string variable with your dashboard URL. The allowed refresh intervals are expressed in seconds: 60, 300, 600, 1800, 3600, 43200, and 86400.
Automatic Dashboard Refresh occurs as part of the TONalytica frontend application. Your refresh schedule is only in effect as long as a logged-in user has the dashboard open in their browser. To guarantee that your queries are executed regularly (which is important for alerts), you should use a Scheduled Query instead.
On public dashboards, there is no Refresh button. You can add refresh
to the query string. And for dashboards with parameters, you can trigger a refresh by changing a parameter value and clicking Apply Changes.
Element | Markdown Syntax |
---|---|
# H1
## H2
### H3
**bold text**
*italicized text
1. First item
2. Second item
3. Third item
- First item
- Second item
- Third item
`code`
---
[title](https://www.example.com)