Dashboards quickstart
By the end of this guide you will have an uptime dashboard built from a template, with a failure-rate widget you added yourself, a $region variable, a saved default time range and a public link.
Requires a paid plan. See plan limits.
You also need at least one monitor, because the template used here reads monitor data.
1. Create the dashboard from a template
Section titled “1. Create the dashboard from a template”-
Open Dashboards in the sidebar and choose New dashboard.
-
Choose From a template, pick Uptime overview and choose Create dashboard.
You now have an ordinary dashboard that is yours to edit.
2. Add a widget with the editor
Section titled “2. Add a widget with the editor”You will chart the share of checks that failed. That takes two queries and a formula.
-
Choose Edit (or press
e). The header turns into an edit bar. -
Choose Add widget, search for Time series and click it. The widget editor opens.
-
Set query a to source Monitors and measure Checks.
-
Choose Add query. Set query b to source Monitors and measure Failed checks. Hide queries a and b so only the formula is drawn.
-
Choose Add formula and enter
b / a * 100(see formulas). Set its unit to Percent and its alias toFailure rate. -
Leave the title empty to use the suggested one, or type your own. Choose Add widget to place the widget on the grid.
Drag the widget to move it, or drag its corner to resize it. Nothing is saved yet.
3. Add a variable
Section titled “3. Add a variable”-
Still in edit mode, open Settings in the edit bar.
-
On the Variables tab, choose Add variable. Name it
region, set Source to Monitors and Field to Region. Leave Allow multiple selections and Include an All option on, with All as the default. -
Choose Save changes. A
regiondropdown appears in the variables bar. -
Open the menu of the Average response time by region chart and choose Edit. Add a filter on Region and choose
$regionas the value. Choose Save widget.
The chart now follows the dropdown: All shows every region, and picking one region shows only that region. The selection is written to the URL as var-region=us-east-1.
4. Change the time
Section titled “4. Change the time”-
Open the time picker. Choose Past 7 days, or type
yesterdayorOct 1 - Oct 3and press Enter. -
Drag across a time chart to zoom in on a spike. Press
zto zoom back out. -
Press
[to step back one window and]to step forward. -
Choose Save as default time in the edit bar to make the current range the one everyone opens the dashboard on.
A time change on its own lives in the URL and does not change the dashboard. Save as default time is what stores it.
5. Save
Section titled “5. Save”-
Choose Save in the edit bar. The dashboard leaves edit mode.
-
Open Version history from the actions menu. Your save is the newest entry, with a short summary of what changed.
6. Share a public link
Section titled “6. Share a public link”-
Choose Share in the header.
-
Choose Create public link. Pick the time ranges viewers can use and the range the page Opens on. Leave
regionon Viewers choose, or set it to Locked. Set a theme and, if you want one, an expiry date. Choose Create link. -
Choose Copy link. It looks like
https://app.siteqwality.com/share/d/<token>. -
Open it in a private window to see what viewers see.
Anyone with the link can see the data in the widgets, read-only. To stop sharing, pause or revoke the link from the same side panel. See sharing.
Prefer the API?
Section titled “Prefer the API?”With an API key exported as SITEQWALITY_API_KEY, this call creates the same board from the template:
curl -X POST https://api.siteqwality.com/dashboards/templates/uptime-overview \ -H "Authorization: Bearer $SITEQWALITY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Uptime overview" }'See the API endpoints.