Appearance
What is Ridge?
Ridge AI builds dashboards from your data. You can embed a published dashboard in your app, with Ridge hosting the dashboard and its data.
The Embed SDK offers two ways to embed a dashboard:
- An iframe embed loads a signed Ridge URL in its own document. You can add it with an
<iframe>tag and control it throughpostMessage. - A JavaScript embed loads directly into your page. Your server creates a short-lived JWT, and the browser API lets you manage state, handle events, customize the theme, and export images.
Both display the same dashboard and use the same state format. They differ in authentication, page isolation, and available controls. See Choose an embed for a comparison.
The guides
- Choose an embed — compare the two options.
- Iframe quickstart — embed a signed URL with no host JavaScript.
- JavaScript quickstart — exchange an API key for a JWT and mount with JavaScript.
- Authentication — separately documented for iframe and JavaScript embeds.
- Dashboard state — read and write component state; discover what each accepts.
- Filters — read and update dashboard filters.
- Partitioning — enforce row-level data access.
- Events — respond to user interactions and wait for rendering to finish.
- Theming — match the dashboard to your product's design.
- Reference — REST endpoints, JavaScript methods, and iframe messages.