Skip to content

docs: SQL chart tiles now supported in embedded dashboards #666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −9
Open

docs: SQL chart tiles now supported in embedded dashboards #666

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions guides/embedding/dashboards.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Dashboard embedding allows you to display full Lightdash dashboards in your appl

### Key features

- Multiple chart tiles and markdown content ([see limitations](#limitations))
- Multiple chart tiles, including saved charts and SQL Runner charts
- Markdown, loom, and heading tiles
- Dashboard-level filters (interactive if enabled)
- Multiple tabs for organizing content
- Parameters support
Expand All @@ -30,14 +31,9 @@ Dashboard embedding allows you to display full Lightdash dashboards in your appl
- "Explore from here" to navigate to query builder
- View underlying data for any visualization

### Limitations

<Warning>
**SQL chart tiles are not supported in embedded dashboards.** Only saved charts created via **Explore** will render. Dashboards containing tiles built in the SQL Runner will fail to load.
</Warning>

- **Symptom:** An embedded dashboard that includes SQL chart tiles surfaces an `Account is not a registered user` error at runtime. This happens because the SQL chart endpoints require a registered Lightdash user, and embed JWT users are anonymous.
- **Workaround:** Rebuild the SQL Runner queries as regular saved charts via **Explore** against the same modeled tables, then replace the SQL chart tiles on the dashboard.
<Note>
SQL Runner chart tiles are authorized through dashboard-tile membership, so they work with existing embed JWTs — you do not need to regenerate tokens or change embed URLs to render them. SQL charts remain embeddable only as part of a dashboard; chart-scoped JWTs (`type: 'chart'`) cannot embed a SQL chart on its own.
</Note>

## Setup

Expand Down
Loading