BI ダッシュボード API

プロジェクトの BI 接続を古い順に 1 ページ 200 件で一覧表示します。次のページには next_cursor を cursor として渡します。シークレットは返されず、secret には設定の有無と末尾 4 文字が示されます。

プロジェクトが所有する BI システムへの接続を追加します。Grafana の場合は、そのアドレス（公開ホスト上の http または https。パスのプレフィックスは任意）と、Viewer ロールのサービスアカウントトークンを指定します。トークンは封印され、返されることはありません。

Grafana renders dashboards for screens through its Image Renderer plugin or remote rendering service, so the customer installs one; run POST /api/bi-connections/{id}/test to check. For Power BI (kind powerbi): config.tenant_id and config.client_id of a Microsoft Entra app registration and its client secret value as secret.

Power BI 管理者は、アプリに対して開発者設定の Embed content in apps と Service principals can call Fabric public APIs を有効にする必要があります（管理ポータル、テナント設定）。アプリは、表示する各ワークスペースのメンバーまたは管理者である必要があり、本番ではレポートに Embedded、Fabric、または Premium の容量が必要です。

For Tableau (kind tableau): config.url (the https address of Tableau Server, or of your Tableau Cloud pod such as https://10ay.online.tableau.com), config.site (the site content URL, empty for the default site), config.client_id and config.secret_id of a connected app with direct trust, config.username (the Tableau user the screens views are shown as) and the secret value as secret.

応答の embed_origin を、接続アプリのドメイン許可リストに追加し、シークレットを有効にします。スクリーンのチケットを持つ人は、そのユーザーが見られるどのビューでも埋め込めるため、スクリーン用のダッシュボードだけを見られるユーザーを使ってください。Tableau Cloud、または Tableau Server 2023.3 以降。

サインインが必要な Web ページ (kind web) 用: サインインの向こうにダッシュボードを表示するサイトのサービスアカウントです。config.login_mode は、auto (config.login_url、config.username、secret としてのパスワード: レンダラーがサインインページを開いてフォームに入力します)、steps (config.login_url と config.steps。goto、fill、click、press、wait_for、wait_ms のステップからなるスクリプトで、値には {{username}}、{{password}}、{{otp}} を含められます)、または none (サインインなし: 接続は、与えたクッキーでページを表示します) のいずれかです。totp_secret は、アカウントの認証アプリの base32 キー、または otpauth:// アドレスです。サーバーがワンタイムコード (RFC 6238) を計算し、レンダラーにはコードだけを送ります。cookies は、サインインをスクリプト化できないサイト (電話で承認するシングルサインオン、デバイスチェックなど) のために、サインイン済みのブラウザーからエクスポートしたクッキーセットです。サーバーはセットを保持し、各キャプチャが返すクッキーで更新するため、サインインが必要になることはまれです。

パスワード、シード、クッキーは封印され、返されることはありません。読み取り専用のサービスアカウントを使ってください。パスワードは config.login_url と goto ステップにだけ入力されるため、それらを別のオリジンに移すには secret をもう一度指定する必要があります。サインインが 5 回続けて拒否されると、認証情報が変更されるまで、接続はサインインしなくなります。

ページレンダラーのないサーバーは bi_web_unavailable を返します。bi_connection.created を追記します。同じ Idempotency-Key での同一の再試行は、同じ応答を返します。

1 つの接続と、その最後のテスト。

Changes a connection's name, address, organization or secret (a sent secret replaces it; an omitted one is kept). Moving a Grafana or Tableau connection to another origin (scheme, host or port) needs the secret in the same request, answered invalid_request at secret otherwise: the stored secret is only sent to the address it was saved for.

アドレスまたはシークレットを変更すると、last_test が消去され、そのビューのキャッシュ済みレンダリングがすべて破棄されます。bi_connection.updated を追加します。If-Match がリビジョンを保護します。

どのビューも使っていない接続を削除します。ビューが使っている間は、その ID を示す resource_conflict が返ります。bi_connection.deleted を追加します。If-Match がリビジョンを保護します。

Calls the BI system with the connection's secret and stores the answer as last_test. For Grafana the checks are token (GET /api/search accepts it) and image_renderer (the plugin is listed; a missing plugin is a warning because a remote rendering service does not show as one).

ダッシュボードごとの権限、データソースの状態、リモートレンダラーへの到達性は判定しません。実際にレンダリングするにはビューをテストしてください。Grafana による拒否はエラーではなく、失敗したチェックとして扱われます。

For Power BI the checks are token (Microsoft Entra accepts the app) and workspaces (the app can list workspaces; it counts them and none fails the check, naming the workspace access step). It does not judge capacity, row-level security or access to any one report: test a view, which generates a real embed token.

For Tableau the check is signin: Tableau accepts a content-read JWT signed with the connected app secret for the connection user, and the server signs out again. It does not judge the domain allowlist, which only a screen loading a view proves, or the permissions on any view: test a view, which looks the view up as the user.

接続のトークンで表示できるものを一覧表示します。Grafana：ダッシュボード（query はタイトルを検索し、next_cursor でページ送り）。dashboard を指定すると、そのダッシュボードのパネル（行はフラット化）が dashboard の下に返ります。

Power BI：アプリから見えるワークスペース（id、name。query は名前に含まれるものだけを残します）。workspace を指定すると、そのワークスペースのレポート（id、name、embed_url）が workspace の下に返ります。

Tableau: 接続ユーザーが見られるビュー (Workbook/View の形式のパス、name)。読み取る 1 ページあたり 100 件です。query は名前またはパスにそれを含むビューだけを残し、見つけるために最大 10 ページまで読み取ります。next_cursor は次に読み取るページです。Web 接続は何も一覧しません。

Lists the project's BI views, oldest first, 200 to a page; pass next_cursor back as cursor for the next. Each carries embed_url, the address an iframe primitive shows (content_fit fill); it is null where this server has no embed host.

接続の Grafana ダッシュボード、またはその 1 つのパネルのビューを追加します（url：接続のホスト上の /d/{uid}/... アドレス、または target）。あるいは Grafana の公開ダッシュボードリンクのビューを追加します（kind grafana と target.public_url。接続は不要）。

Put the answer's embed_url in an iframe primitive: the server renders the dashboard as a PNG through Grafana's /render API, refreshed every refresh_s (30 to 86400, default 300) and shared by every screen of the same size; the screen never talks to Grafana. A public dashboard plays live from Grafana, which must allow embedding.

埋め込みページは、画面のマニフェストが持つチケットだけを表示するため、ビューは自分のプロジェクトの画面でのみ再生されます。

For Power BI (kind powerbi): a report of a workspace the connection's app is a member of (url: an app.powerbi.com /groups/{workspace}/reports/{report} address, or target with workspace_id and report_id), with pages to show and rotate_s to rotate through them (pages listing two or more, or rotate_all_pages, need rotate_s of 10 to 3600; one report page needs none), and refresh_s of 0 (no refresh) or 60 to 86400 (default 300).

The page asks the server for a short-lived view-only embed token (GenerateToken, App owns data) and renews it before it expires; the screen never holds the client secret. A Power BI Publish to web link is a view without a connection (kind powerbi, target.public_url https://app.powerbi.com/view?r=...), framed as it is.

For Tableau (kind tableau): a view of the connection site (url: an address copied from Tableau, such as https://HOST/t/SITE/views/WORKBOOK/VIEW or Tableau Cloud https://HOST/#/site/SITE/views/WORKBOOK/VIEW, or Workbook/View; or target.view), optionally with target.rotate_sheets and rotate_s of 10 to 3600 to turn the workbook published sheets (rotate_s and rotate_sheets go together; rotate_sheets may be given as the whole target beside url), and refresh_s of 0 (no refresh) or 60 to 86400 (default 300).

The page asks the server for a five minute JWT with only the embed scope, signed with the connected app secret, and builds the Embedding API v3 tableau-viz from the Tableau host; the screen never holds the secret.

Tableau Public のビジュアライゼーションは、接続なしのビュー (kind tableau、target.public_url。https://public.tableau.com/views/WORKBOOK/VIEW として再構築されます) で、rotate_sheets も使えます。Web ページ (kind web) の場合: Web 接続のサイトの 1 ページ (url: 公開ホスト上の https アドレス。target は指定しません)。

エッジのブラウザーが、サインインした状態でページを開き、設定されていれば wait_for の要素を待ち、wait_ms ミリ秒 (最大 10000) 待ってから、設定されていれば CSS セレクターの clip を、なければページ全体を描画します。

画像は refresh_s (60 〜 86400、デフォルトは 300) ごとに描き直され、同じサイズのすべてのスクリーンで共有されます。描画されるのは、スクリーンがそのビューを表示している間だけです。キャプチャが失敗した場合は、最後の画像がスクリーンに残ります。サインイン済みのときだけ存在する要素を wait_for に設定すると、サインインページが表示されることはありません。bi_view.created を追記します。

embed_url と、最後に画面上でどうだったか（status）を含むビュー 1 件。

Changes a view's name, target (url or target replaces the whole target), cadence or fit. A new target clears status, and every render cached for the old one is retired. A view keeps its connection and kind. Appends bi_view.updated. If-Match guards the revision.

ビューを削除します。その embed_url をまだ表示している画面は、プレイリストが変わるまで画面上で not_found を返します。bi_view.deleted を追加します。If-Match がリビジョンを保護します。

Renders a connection view for real (1920x1080, outside the shared cache and without touching status), or fetches a public dashboard link and checks that its page may be framed by the view's embed host (allow_embedding in Grafana). It does not judge what the picture shows. A Grafana failure is a failed check, not an error.

Power BI の接続ビューは、そのレポートの本物の埋め込みトークンを生成します（report と embed_token を確認）。指定したページ、容量、レポートの内容は判定しません。行レベルセキュリティのあるデータセットは Power BI が独自のメッセージで拒否し、そのメッセージがチェックに表示されます。Power BI の公開リンクは取得され、フレーム化に関するヘッダーが読み取られます。

Tableau の接続ビューは、接続ユーザーとしてサインインしてビューを検索します（signin と view を確認）。ドメイン許可リスト、埋め込み権限、ビューの内容は判定しません。Tableau Public のビューは、ワークブックが存在するかを Tableau Public に問い合わせ、ビュー名は判定しません。

Grafana または Web のビューを今すぐ PNG として描画します (Power BI または Tableau のビューは not_found を返します)。共有キャッシュは使わないので、テストでは、Grafana またはブラウザーがそのサイズで描画するとおりのものが分かります。埋め込みページ自体は共有の描画を使います。