POST
/
api
/
v2
/
dataApp
/
embed
/
list
{
  "isPagination": "boolean (optional)",
  "pageNumber": "number (optional)" //10 items per page
}
{
  "data": [
    {
      "embedId": "string",
      "externalDashboard": {
        "externalDashboardId": "string",
        "name": "string"
      },
      "externalMetric": {
        "externalMetricId": "string",
        "name": "string"
      },
      "embedType": "dashboard" | "metric",
      "embedDataAppAccessSetting": {
        "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"
          }
        ]
      }
    }
  ],
  "error": null
}
Fetch a list of all embeds created by the authenticated data app.

Headers

Authorization
string
required
Bearer API TOKEN

POST /list

Request Body

isPagination
boolean
(Optional) Whether to paginate results.
pageNumber
number
(Optional) Page number if pagination is enabled. Default is 1.
{
  "isPagination": "boolean (optional)",
  "pageNumber": "number (optional)" //10 items per page
}

Response

{
  "data": [
    {
      "embedId": "string",
      "externalDashboard": {
        "externalDashboardId": "string",
        "name": "string"
      },
      "externalMetric": {
        "externalMetricId": "string",
        "name": "string"
      },
      "embedType": "dashboard" | "metric",
      "embedDataAppAccessSetting": {
        "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"
          }
        ]
      }
    }
  ],
  "error": null
}

Possible Errors

CodeMessageHTTP Status
INVALID_DATA_APP_API_KEYMissing or invalid data app400
INTERNAL_SERVER_ERRORUnexpected failure500