ダッシュボードAPIsを使用してダッシュボードを作成および管理する

Databricks REST API には、AI/BI ダッシュボードを管理するための管理ツールが含まれています。 この記事では、既存のレガシーダッシュボードから新しいAI/BIダッシュボードを作成する方法について説明します。 次に、API ツールを使用してダッシュボードを管理する方法を示します。

注：

AI/BI ダッシュボードは、以前は Lakeview ダッシュボードと呼ばれていました。 Lakeview API は、その名前を引き続き保持します。

前提条件

ダッシュボードの移行

既存のレガシーダッシュボードから新しいAI/BIダッシュボードを作成できます。 Lakeview API の Migrate ダッシュボード エンドポイントには、 source_dashboard_idが必要です。 必要に応じて、表示名と、新しいダッシュボードを保存するパスを含めることができます。

Databricks SQL ダッシュボードを入手する

source_dashboard_idを取得するには、Databricks SQL ダッシュボード API を使用して、ワークスペース内のすべてのダッシュボードの一覧を取得します。results リストの各ダッシュボード オブジェクトには、Databricks REST API サービス全体でレガシ ダッシュボードを参照するために使用できる UUID が含まれています。

次の例は、 Get dashboard objects エンドポイントのサンプル要求と応答を示しています。 わかりやすくするために、一部の回答の詳細は省略されています。 「GET /api/2.0/preview/sql/dashboards」を参照してください。 このエンドポイントとサンプル応答の詳細については、こちらをご覧ください。

レガシーダッシュボードの UUID は、 resultsで返されるオブジェクトのリストの最上位からidです。レガシーダッシュボードの場合、UUID は 4e443c27-9f61-4f2e-a12d-ea5668460bf1のようになります。

GET /api/2.0/preview/sql/dashboards

Query Parameters:

{
"page_size": <optional>,
"page": <optional>,
"order": <optional>
"q": <optional>
}

Response:

{
  "count": 1,
  "page": 1,
  "page_size": 25,
  "results": [
    {
      "id": "4e443c27-9f61-4f2e-a12d-ea5668460bf1",
      "slug": "sales-dashboard",
      "parent": "folders/2025532471912059",
      ...
    }
  ]
}

レガシーダッシュボードの移行

レガシーダッシュボードに関連付けられたUUIDを使用して、新しいAI/BIダッシュボードに自動的に変換されるコピーを作成します。 これは、UIで利用可能な AI/BIダッシュボードツールへのクローン 作成のように機能します。 Databricks UI を使用してこの操作を実行する方法については、「 レガシ ダッシュボードを AI/BI ダッシュボードに複製 する」を参照してください。

変換するレガシ ダッシュボードの UUID は、要求本文に必要です。 オプションで、新しい display_name 値と、変換されたダッシュボードを保存するフォルダーのワークスペース パスを識別する parent_path を含めることができます。

応答には、新しいダッシュボードの UUID である dashboard_idU が含まれます。 AI/BI ダッシュボードの UUID は、 04aab30f99ea444490c10c85852f216cのような 32 桁の英数字の値です。 これを使用して、Lakeview 名前空間内およびさまざまな Databricks REST API サービス間でこのダッシュボードを識別できます。

次の例は、サンプルの要求と応答を示しています。 「/api/2.0/Lakeview/dashboards/migrate」を参照してください。

POST /api/2.0/lakeview/dashboards/migrate

Request body parameters:
{
  "source_dashboard_id": "4e443c27-9f61-4f2e-a12d-ea5668460bf1",
  "display_name": "Monthly Traffic Report",
  "parent_path": "/path/to/dir"
}

Response:
{
  "dashboard_id": "04aab30f99ea444490c10c85852f216c",
  "display_name": "Monthly Traffic Report",
  "path": "/path/to/dir/Monthly Traffic Report.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "47bb1c472649e711",
  "etag": "80611980",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

下書きダッシュボードを取得する

この dashboard_id を使用して、ドラフトダッシュボードからダッシュボードの詳細を取得できます。 次のサンプル要求と応答には、ワークスペース内の下書きダッシュボードの現在のバージョンの詳細が含まれています。

etag フィールドは、ダッシュボードの最新バージョンを追跡します。これを使用して、追加の更新を行う前にバージョンを確認できます。

GET /api/2.0/lakeview/dashboards/04aab30f99ea444490c10c85852f216c

Response:

{
  "dashboard_id": "04aab30f99ea444490c10c85852f216c",
  "display_name": "Monthly Traffic Report",
  "path": "/path/to/dir/Monthly Traffic Report.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "47bb1c472649e711",
  "etag": "80611980",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

ダッシュボードを更新する

前の応答の dashboard_id を使用して、その操作で作成された新しい AI/BI ダッシュボードを更新できます。 次の例は、サンプルの要求と応答を示しています。 前の例の dashboard_id は、パス パラメーターとして含まれています。

display_nameとwarehouse_idが変更されました。更新されたダッシュボードには、応答に示されているように、新しい名前と割り当てられたデフォルト ウェアハウスがあります。 etagフィールドはオプションです。etagで指定されたバージョンが現在のバージョンと一致しない場合、更新は拒否されます。

PATCH /api/2.0/lakeview/dashboards/04aab30f99ea444490c10c85852f216c

Request body:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "c03a4f8a7162bc9f",
  "etag": "80611980"
}

Response:

{
  "dashboard_id": "04aab30f99ea444490c10c85852f216c",
  "display_name": "Monthly Traffic Report 2",
  "path": "/path/to/dir/Monthly Traffic Report 2.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "c03a4f8a7162bc9f",
  "etag": "80611981",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

ダッシュボードを作成する

Lakeview API の Create dashboard エンドポイントを使用して、ワークスペース間でダッシュボードを移動できます。 次の例には、新しいダッシュボードを作成するサンプルの要求本文と応答が含まれています。 前の例の serialized_dashboard キーには、重複するドラフト ダッシュボードを作成するために必要なすべての詳細が含まれています。

このサンプルには、新しいワークスペースのウェアハウスに対応する新しい warehouse_id 値が含まれています。 POST /api/2.0/Lakeview/dashboardsを参照してください。

POST /api/2.0/lakeview/dashboards

Request body:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "parent_path": "/path/to/dir"
}

Response:

{
  "dashboard_id": "1e23fd84b6ac7894e2b053907dca9b2f",
  "display_name": "Monthly Traffic Report 2",
  "path": "/path/to/dir/Monthly Traffic Report 2.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "5e2f98ab3476cfd0",
  "etag": "14350695",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

要求本文の唯一の必須プロパティは display_nameです。 このツールは、ダッシュボードのコンテンツをコピーしたり、新しい空白のダッシュボードを作成したりできます。

ダッシュボードを公開する

ダッシュボードの公開エンドポイントを使用して、ダッシュボードの公開、閲覧者の資格情報の設定、およびドラフトダッシュボードで設定されたwarehouse_idの上書きを行うことができます。ダッシュボードの UUID をパス パラメーターとして含める必要があります。

要求本文では、 embed_credentials プロパティを falseに設定します。 デフォルトでは、 embed_credentials は trueに設定されています。 認証情報を埋め込むと、アカウントレベルのユーザーはダッシュボードのデータを表示できます。 「ダッシュボードの公開」を参照してください。新しい warehouse_id 値は省略されるため、公開されたダッシュボードでは、ドラフト ダッシュボードに割り当てられたものと同じウェアハウスが使用されます。

POST /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

Request body:

{
  "embed_credentials": false
}

Response:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "embed_credentials": false,
  "revision_create_time": "2019-08-24T14:15:22Z"
}

公開済みダッシュボードを取得する

GET /api/2.0/Lakeview/dashboards/{dashboard_id}/published からの応答は、前の例で提供された応答と似ています。dashboard_idはパス パラメーターとして含まれています。

GET /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published


Response:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "embed_credentials": false,
  "revision_create_time": "2019-08-24T14:15:22Z"
}

ダッシュボードを非公開にする

ドラフトダッシュボードは、Lakeview API を使用してダッシュボードを非公開にしても保持されます。 この要求により、ダッシュボードの公開済みバージョンが削除されます。

次の例では、前の例の dashboard_id を使用しています。 要求が成功すると、 200 ステータス コードが生成されます。 応答本文はありません。

DELETE /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

ダッシュボードを捨てる

DELETE /api/2.0/Lakeview/dashboards/{dashboard_id} を使用して、ドラフトダッシュボードをゴミ箱に送信します。ダッシュボードは引き続き回復できます。

次の例では、前の例の dashboard_id を使用しています。 要求が成功すると、 200 ステータス コードが生成されます。 応答本文はありません。

DELETE /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f

注：

完全な削除を実行するには、POST /api.2.0/ワークスペース/delete を使用します

次のステップ