POST
/
api
/
v2
/
dataApp
/
embed
/
create
{
  "dashboardId": "string",
  "embedType": "dashboard" | "metric",
  "metricId": "string (required if embedType is 'metric')",
  "workspaceName": "string",
  "accessSettings": {
    "datamartName": "string",
    "isAllowAipilot": true,
    "isAllowEmailReports": false,
    "isAllowManageMetrics": true,
    "isAllowMetricCreation": true,
    "isAllowMetricDeletion": true,
    "isAllowMetricLayoutChange": true,
    "isAllowMetricUpdate": true,
    "isAllowUnderlyingData": false,
    "metricCreationMode": "DRAG_DROP" | "CHAT",
    "tableList": [
      {
        "clientColumn": "string",
        "name": "string"
      }
    ]
  }
}

{
  "id": "string",
  "error": null
}
Create an embed configuration for a dashboard or a metric using the POST /create endpoint.

​
Headers

​
Authorization
string
required
Bearer API TOKEN

​
POST /create

Create an embed configuration for a dashboard or a metric.

​
Request Body

​
dashboardId
string
Dashboard ID to embed (required if embedType is dashboard).
​
embedType
'dashboard' | 'metric'
required
Specifies the type of embed — either a dashboard or metric.
​
metricId
string
Metric ID (required if embedType is metric).
​
workspaceName
string
required
The name of the workspace in which the embed config will be created.
​
accessSettings
object
required
Access settings for the embedded view.
​
accessSettings.datamartName
string
required
The datamart name used in the embedded environment.
​
accessSettings.isAllowAipilot
boolean
Allow AI pilot features.
​
accessSettings.isAllowEmailReports
boolean
Allow sending email reports.
​
accessSettings.isAllowManageMetrics
boolean
Allow managing metrics.
​
accessSettings.isAllowMetricCreation
boolean
Allow metric creation.
​
accessSettings.isAllowMetricDeletion
boolean
Allow metric deletion.
​
accessSettings.isAllowMetricLayoutChange
boolean
Allow layout changes to metrics.
​
accessSettings.isAllowMetricUpdate
boolean
Allow updating metrics.
​
accessSettings.isAllowUnderlyingData
boolean
Allow viewing of underlying data.
​
accessSettings.metricCreationMode
'DRAG_DROP' | 'CHAT'
Mode of metric creation (drag and drop or chat).
​
accessSettings.tableList
array
List of allowed tables in embed.
​
accessSettings.tableList[].clientColumn
string
Client-level column for table tenancy.
​
accessSettings.tableList[].name
string
Table name.
{
  "dashboardId": "string",
  "embedType": "dashboard" | "metric",
  "metricId": "string (required if embedType is 'metric')",
  "workspaceName": "string",
  "accessSettings": {
    "datamartName": "string",
    "isAllowAipilot": true,
    "isAllowEmailReports": false,
    "isAllowManageMetrics": true,
    "isAllowMetricCreation": true,
    "isAllowMetricDeletion": true,
    "isAllowMetricLayoutChange": true,
    "isAllowMetricUpdate": true,
    "isAllowUnderlyingData": false,
    "metricCreationMode": "DRAG_DROP" | "CHAT",
    "tableList": [
      {
        "clientColumn": "string",
        "name": "string"
      }
    ]
  }
}

​
Response

{
  "id": "string",
  "error": null
}

​
Error Response

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 400
  }
}

​
Possible Errors

CodeMessageHTTP Status
INVALID_WORKSPACE_NAMEInvalid workspace name400
INVALID_DATA_APP_API_KEYMissing or invalid data app400
INVALID_DASHBOARD_IDDashboard not found400
INVALID_METRIC_IDMetric not found400
INTERNAL_SERVER_ERRORUnexpected failure500
INVALID_DATAMARTInvalid datamart400
DATAMART_TABLE_NOT_FOUNDDatamart table not found (If the datamart uses table-level tenancy but has no configured tables.)400
INVALID_DATAMART (again)Invalid datamart tenancy level (When the datamart’s tenancy level doesn’t match the workspace’s expected tenancy.)400