End User Dashboard Creation

Create a Datamart

Create a Datamart in “Data Studio” page. Kindly refer the below link on how to create datamarts:

Create a Datamart

Create a Workspace with Datamart connection

For more details, kindly refer the below link:

Workspace

**Create a Dashboard **

For more details, kindly refer the below link:

Create a Dashboard

Create a DataApp

For more details, kindly refer the below link:

Create a Data App

Generate API Token

Navigate to the Data App.
In the “API Token” section, generate the API token by specifying the name of company and description (optional)

API Methods Cloud Databrain:

POST https://api.usedatabrain.com/api/v2/dataApp/embed/{method_path}

Self-hosted Databrain:

POST <SELF_HOSTED_URL>/api/v2/dataApp/embed/{method_path}

Create a Dashboard

POST https://api.usedatabrain.com/api/v2/dataApp/dashboardEmbed/create

POST <SELF_HOSTED_URL>/api/v2/dataApp/dashboardEmbed/create

{
  "dashboardId": "id",
  "clientId": "102", 
  "templateDashboardId": "demo-sales-test-dashboard", // dashboard id to clone filters
  "metadata": {"created_at": "2025-09-25", "name":"lyman's dashboard", "descriptions":"created for 102 client id, it's end user dashboard embed"}, // metadata of dashboard	
  "workspaceName": "Demo Sales API",
  "accessSettings": {
    "datamartName": "Demo Sales API Test Datamart",
    "isAllowAiPilot": true,
    "isAllowEmailReports": false,
    "isAllowManageMetrics": true,
    "isAllowMetricCreation": true,
    "isAllowMetricDeletion": true,
    "isAllowMetricLayoutChange": true,
    "isAllowMetricUpdate": true,
    "isAllowUnderlyingData": false,
	"isAllowCreateDashboardView": false,
    "metricCreationMode": "DRAG_DROP",
    "tableTenancySettings": [
      {
        "clientColumn": "client id",
        "name": "demo_sales"
      }
    ]
  }
}
// database tenancy don't require table list

dashboardId – Unique external dashboard ID (must not already exist).
workspaceName – Must match a valid workspace linked to the API token’s company.
clientId – Identifier of the client for which the dashboard is being created.
templateId – Optional. External dashboard ID of a template to clone.
accessSettings – Required. Defines permissions and feature access for the embed.

Create Guest token by passing Client ID and DataApp Name

When you need a guest token that you want to use across dashboards and metrics. All you have to do is pass clientId, dataAppName. If expiryTime is not passed, the token will not expire.

Generating GUEST TOKEN for your Dashboard

Headers

Name	Type	Description
Authorization*	String	Bearer (API Token)

Request Body

Name	Type	Description
dataAppName*	String	Your Data App Name
clientId*	String	Client ID for whom this guest token is generated. (`"clientId": "None"` if no tenancy is selected for connected datasource/datamart)
params	Object	Additional Params: `dashboard`, `appFilters`
expiryTime	Number	In milliseconds
datasourceName	String	Datasource name from Data Studio (*important and supported in multi-datasource connection in workspace)

Example Response: 200 OK “token”: ”…”

when the response is successful it returns a token that you can pass to the frontend.

When the response is successful it returns a token that you can pass to the frontend.

Simple Request Body

{
  "clientId": "102",
  "dataAppName": "Demo Sales API"
}

Once you acquire the guest token, you can seamlessly pass it to your frontend application, where it can be integrated with the web component

The created dashboard will mimic the filter behavior of the cloned dashboard if a Template ID is provided.
Once the dashboard is created, users can start building metrics.

This API creates a client end-user dashboard, including when it clones a template. End users can use saved Custom SQL metrics and filters, but cannot edit Custom SQL metrics or submit filter definitions containing Custom SQL. Enabling metric update permissions does not remove this restriction. For a dashboard in your own workspace, use the Import Dashboard API instead. See the Dashboard Embed API for the current endpoint and import options.

Dashboard Updation

POST /embed/update

{
  "embedId": "id",
  "accessSettings": {
    "datamartName": "Demo Sales API Test Datamart",
    "isAllowAiPilot": true,
    "isAllowEmailReports": false,
    "isAllowManageMetrics": true,
    "isAllowMetricCreation": true,
    "isAllowMetricDeletion": true,
    "isAllowMetricLayoutChange": true,
    "isAllowMetricUpdate": true,
    "isAllowUnderlyingData": true,
	"isAllowCreateDashboardView": false,
    "metricCreationMode": "DRAG_DROP",
    "tableTenancySettings": [
      {
        "clientColumn": "client id",
        "name": "demo-sales"
      }
    ]
  }
}

Embedded Dashboard Deletion

POST /embed/delete

{
  "embedId": "id"
}

Embedding Setup

MCP Server

Framework Integration

Component Options

Authentication & Security

Filtering & Personalization

Customization

Events & Interactions

End-User Features

AI Chat Mode

Self-Hosted Deployment

Solution Patterns

Testing & Debugging

Migration & Legacy

Additional Resources

End User Dashboard Creation

Create a Datamart

Workspace

Create a Dashboard

Create a Data App

Generating GUEST TOKEN for your Dashboard

Headers

Request Body

Simple Request Body