セマンティックモデルの更新履歴を REST API で取得する方法

こんにちは、 Power BI サポートチームの山下です。
多くのユーザー様から、Power BI サービス上のセマンティックモデルの更新履歴（更新開始時間、終了時間、成否結果など）を一括で取得したいというお問い合わせをいただきます。
画面上では、個々のセマンティックモデルの更新履歴画面から確認することが可能ですが、セマンティックモデルの数が多い場合、手作業での確認は非常に大変です。
そこで、本記事では、REST API を使用して、ユーザーが権限をもつワークスペースに存在するセマンティックモデルの更新履歴を一括で取得する方法をご紹介します。
この方法を使用することで、作業の効率化、時間の節約にもつながりますので、状況に応じてぜひご活用ください。

重要

本記事は弊社公式ドキュメントの公開情報を元に構成しておりますが、本記事編集時点と実際の機能に相違がある場合がございます。

最新情報につきましては、参考情報として記載しておりますドキュメントをご確認ください。

“Get Refresh History In Group”の利用方法

セマンティックモデルの更新履歴更新開始時間・終了時間・成否結果などの情報につきましては、GUI 以外では “Get Refresh History In Group” という Power BI REST API にて取得可能です。
ただし、API を実行するアカウントが対象のセマンティックモデルに対して読み取り権限を持っていることが前提条件となります。
グローバル管理者や Fabric 管理者（ Power BI 管理者）であっても、対象のセマンティックモデルに対して読み取り権限を持たない場合は情報取得することができませんことを予めご了承ください。
ご参考情報：
Datasets - Get Refresh History In Group

こちらの公式ドキュメントの［▷使ってみる］をクリックすると画面右側にフォーカスモードが開始されます。
Power BI サービスを使用するアカウントでサインイン後、API の動作をお試しいただけます。

以下は “Get Refresh History In Group” の実行結果の例となります。

＝＝　実行結果例　（ UTC 時間となりますので、日本時間と 9 時間のずれが生じます。）＝＝

{
     "requestId": "40935061-9857-41c9-a684-8bc97b4cbc7e",
     "id": 317934293,
     "refreshType": "Scheduled",　<-- 更新の種類
     "startTime": "2024-08-15T04:30:25.867Z",　　<-- 更新開始時間
     "endTime": "2024-08-15T04:30:30.88Z",　　　<-- 更新終了時間
     "status": "Completed",　　　<--　更新の成否の結果　
     "refreshAttempts": [　　＜-- これ以降は、より詳細な更新処理内容の情報となります。※1
       {
         "attemptId": 1,
         "startTime": "2024-08-15T04:30:26.225194Z",
         "endTime": "2024-08-15T04:30:30.6002893Z",
         "type": "Data"
       },
       {
         "attemptId": 1,
         "startTime": "2024-08-15T04:30:30.7252936Z",
         "endTime": "2024-08-15T04:30:30.8034226Z",
         "type": "Query"

//　該当の更新履歴（ GUI ）

※１　ご参考情報：

セマンティックモデルの更新履歴

＊　関連箇所抜粋＊
Power BI 更新の試行はそれぞれ 2 つの操作に分けられます。
データ – セマンティックモデルにデータを読み込む　　
クエリキャッシュ – Premium クエリキャッシュやダッシュボードタイルの更新

groupId と datasetId の指定

本 API では、対象のセマンティックモデルの groupId と datasetId を指定する必要がございます。
groupId と datasetId は、Web ブラウザで Power BI サービスにサインインし、対象のセマンティックモデル画面を開いた際のアドレスバーに表示されるURLからご確認いただけますが、以下 API を使用することで、一括で情報を取得することも可能です。

https : // app.powerbi.com/groups/ groupId /datasets/ datasetId /details?experience=power-bi

ご参考情報：
Admin - Datasets GetDatasetsAsAdmin
テナント内に存在するデータセットの一覧を返します。
Datasets - Get Datasets In Group
指定したワークスペースからデータセットの一覧を返します。

上記をおまとめいたしますと、① “Datasets GetDatasetsAsAdmin” や Get Datasets In Group” の API の実行結果から各セマンティックモデルの groupId と datasetId を取り出し、② その情報をもとに Get Refresh History In Group“ を実行するようなスクリプトを作成いただくことで、読み取り権限をもつセマンティックモデルのスケジュール更新の更新履歴を一括で取得することが可能になります。

Power BI Desktop から直接 REST API の実行結果を取得する方法

Power BI Desktop から直接 REST API の実行結果を取得する方法として、「PowerBIRESTAPI」というカスタムコネクタを利用する方法があります。

ご参考情報：
PowerBIRESTAPI

※なお、本カスタムコネクタは Microsoft が開発しているものではないため、コネクタ自体の動作に関して問題が生じた場合弊社でご支援することが難しいです。　　
ご利用の際は貴社にて十分に検証・検討を実施いただきますようお願いいたします。　　

カスタムコネクタの利用方法

上記 github のサイトから取得したコネクタの .mez ファイルをローカルの [ ドキュメント ]\Microsoft Power BI Desktop\Custom Connectors フォルダーに入れてください。
フォルダーが存在しない場合は、ローカルにて上記のフォルダーを作成します。　　
データ拡張機能のセキュリティ設定を調整するため、Power BI Desktop で、[ファイル] > [オプションと設定] > [オプション] > [セキュリティ] の順に展開ください。
[データ拡張機能から [(非推奨) 検証または警告せずに、あらゆる拡張機能の読み込みを許可する] を選択ください。　　
[OK] を選択して、Power BI Desktop を再起動ください。

※ Power BI Desktop のデータ拡張機能の既定のセキュリティ設定は、[(推奨) Microsoft 認定の拡張機能と他の信頼されたサードパーティー製の拡張機能のみの読み込みを許可する] です。
今回ご紹介しているカスタムコネクタは、認定されていないカスタムコネクタとなっているため、上記設定が必要となります。

その後、[データを取得] から [詳細] を展開いただき、Power BI API (ベータ) (カスタム)を選択し、接続ください。

REST API を実行する Entra ID アカウントでサインインを行い、接続ください。

その後、表示されますナビゲーター画面にて [Workspaces] を展開いただき、[Refresh History] をご確認ください。
サインインしたアカウントが権限をもつセマンティックモデルの、Workspace ID、Dateset ID、更新開始時間と終了時間および成否等の情報を一括で取得することが可能になります。

カスタムコネクタの詳細については、以下の公開情報に説明がございます。
ご参考情報：
Power BI でのコネクタの機能拡張

以上、本ブログが少しでも皆様のお役に立てますと幸いでございます。

アンケートご協力のお願い
Japan CSS Support Power BI Blog では、作成する記事やブログの品質向上を目的に、匿名回答でのアンケートを実施しております。
ユーザー様のご意見・ご要望を参考に今後もお役に立てるブログを目指してまいりますので、ぜひご協力いただけますと幸いでございます。

※　所要時間は1分程度となります。
【ご協力のお願い】Microsoft Japan CSS Power BI Blog ご利用に関するアンケート

※本情報の内容（添付文書、リンク先などを含む）は、作成日時点でのものであり、予告なく変更される場合があります。

“Get Refresh History In Group”の利用方法

groupId と datasetId の指定

Power BI Desktop から直接 REST API の実行結果を取得する方法

カスタム コネクタの利用方法

カスタムコネクタの利用方法