Skip to main content

Embed Portal

Coming Soon

This feature is under development and will be coming soon!

Introduction

Embed Portal allows developers to embed a mini BI application within their application. Developers can distribute multiple dashboards to embed users, as well as allow embed users to self-serve and customize their own dashboards.

  • Embedded Self-Service: Let embedded customers explore data, interact with visualizations, and create custom dashboards without leaving your application.
  • Built-in User Organization: Group embedded users into distinct organizations with strict data boundaries between different organizations.
  • Collaborative Workspaces: Enable dashboard sharing within each organization's workspace with configurable permissions for different user roles.
  • Tiered Access Control: Create different analytics experiences based on subscription tiers by controlling access to specific dashboards, datasets, and features.
  • Developer-Friendly Integration: Define portals as code, intuitive sandbox UI for integration, integrate with version control, and use preview environments to streamline your development workflow.

How it works

  1. Define: Developers define an embed portal that contains multiple data assets (dashboards and datasets) along with settings and permission rules in code.
  2. Publish & Integrate: After publishing, integrate the portal into your web application using a single embed secret key and iframe.
  3. Access Control: Row-level permissions defined in datasets apply automatically to all embedded content, with user attributes in the payload determining what data is visible.
  4. User Organization: Embedded users and organizations are identified via embed_user_id and embed_org_id parameters, enabling personal workspaces and shared organizational environments.
  5. Self-service Analytics: Embedded users can explore data, create dashboards, and collaborate based on their permissions—all within your application.

Let us know what you think about this document :)