Quickstart
Ship your first embedded dashboard in about 15 minutes (Platform tier).
Prerequisites
- Embedded Canvas workspace (sign up)
- Warehouse reachable from your analytics runtime
- Tenant column on embedded datasets (
customer_idor your chosen key)
Operators run the console sidebar path below. Engineering mounts the SDK after you hand them keys.
The analytics runtime starts automatically after signup. There is no Setup wizard.
Steps
1. Confirm runtime
Operator console landing — wait until Runtime healthy, then open Dashboard builder (SSO) to author in hosted Apache Superset.
2. Connect data
Sidebar Connections — connect warehouse, set tenant column, test connection, sync.
Guide: Connect warehouse.
3. Register a dashboard
Sidebar Dashboards (page Register dashboards) — register the board, set iframe parent origins. Match Allowed domains in the builder (dual allowlist).
Guide: Dashboards & allowlists.
4. Mint sessions (backend)
Create an embed API key in sidebar Embed (page Connect your application), then mint guest sessions server-side (session-route BFF recommended).
Guide: Mint embed sessions.
5. Mount in your app (frontend)
Use @embeddedcanvas/embed-sdk — web component or framework adapter.
For framework-specific walkthroughs — SDK + session route, SDK + JWT direct, and Hosted iframe — see Intro tutorials in the developer docs sidebar, or the stack picker on the Embed page.
Verify
- Test Embed (
/analytics/test-embed) with two customer ids — metrics must differ (RLS) - Test & monitor (
/analytics/test) — run embed preflight - Open Usage — confirm session mints increment
Review Security & compliance before production traffic.
To share a board with a teammate (not a customer embed), use Share dashboards.