Embed Reports and Dashboards (Formerly BrightGauge) in Hudu

You can display Reports and Dashboards inside Hudu so technicians and stakeholders have live metrics alongside your documentation. There are two ways to do this:

• Embed a BrightGauge public dashboard or public gauge in a KB article, process, company Quick Note, or asset Embed field.
• Use Hudu's Magic Dash to keep embedded content front and center on a company's overview page.

Prerequisites

• BrightGauge user role: You must be an Admin or Analyst in BrightGauge to generate public dashboard or public gauge links. Viewer users cannot generate public URLs but can open links you provide.
• BrightGauge plan:
  • Enterprise: Required for public dashboards and public gauges, which can be embedded with an iframe.
  • Basic/Team: No public embed options are available. You can link to reports (login required) or upload screenshots and exports into Hudu.

Embed a BrightGauge public dashboard

• In BrightGauge, open the dashboard and select More → Public URL. Enable the public URL and copy the link.
• In Hudu, open the KB article, process, Quick Note, or asset where you want the dashboard to appear.
  • For KB articles, processes, and Quick Notes, click the Source code icon (</>) in the top right of the Notion-style editor toolbar.
  • For assets, make sure the asset layout includes an Embed field, then paste the iframe into that field.

• Paste the iframe code, replacing YOUR_PUBLIC_URL with your BrightGauge public URL:

  <iframe
    src="YOUR_PUBLIC_URL"
    title="BrightGauge Dashboard"
    width="100%"
    height="600"
    frameborder="0"
    allowfullscreen>
  </iframe>

• Save your changes. The dashboard should display and update automatically.

Alternatives to public dashboards

• Public gauges (Enterprise only): Individual gauges (KPIs) can be made public and embedded with an iframe, the same way as dashboards. This is a lighter-weight option when you only need a single metric.
• Reports: Reports cannot be embedded, but you can paste a report's URL into Hudu. Anyone who clicks the link will need to log in with a BrightGauge account to view it.
• Screenshots: If embedding isn't possible, export a screenshot of a gauge or dashboard from BrightGauge and upload it to your Hudu documentation.

Display a dashboard or gauge with Magic Dash

Magic Dash lets you create dynamic dashboard widgets in each company's space. Magic Dash items are created through the Hudu API rather than pasted into an editor.

• Generate an API key: Go to Admin → API Keys and create a key for Magic Dash.
• Create a Magic Dash item: Use the Hudu REST API (documented in the admin area under API → View API Documentation) to send a POST request with a JSON payload that defines your widget.

Example JSON payload:

{
  "title": "BrightGauge Dashboard",
  "company_name": "AcmeCorp",
  "message": "Live KPIs from BrightGauge",
  "content": "<iframe src='YOUR_PUBLIC_URL' width='100%' height='300' frameborder='0' allowfullscreen></iframe>",
  "content_link": "",
  "icon": "fas fa-chart-line",
  "shade": "success"
}

Include the iframe in the content field to display the dashboard inside the Magic Dash widget, or use content_link to add a link that opens the public dashboard in a new page. Only one of these fields can be used at a time.

Once the request is processed, the BrightGauge content appears on the company's Magic Dash and updates automatically as long as the iframe points to a live BrightGauge public URL.

Security and access notes

• Public dashboards and gauges are read-only and can be disabled in BrightGauge at any time. Anyone with the public URL can view them.
• Viewer accounts: If you can't use public dashboards, share dashboards internally with BrightGauge Viewer accounts and link to them in Hudu (login required).

Troubleshooting