API de Paneles BI

Lista las conexiones BI del proyecto, de la más antigua a la más reciente, 200 por página; devuelva next_cursor como cursor para la siguiente. Un secreto nunca se devuelve: secret indica si está definido y sus últimos 4 caracteres.

Agrega una conexión a un sistema BI del que el proyecto es propietario. Para Grafana: su dirección (http o https en un host público, con un prefijo de ruta opcional) y un token de cuenta de servicio con el rol Viewer. El token se sella y nunca se devuelve.

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.

Un administrador de Power BI debe activar los ajustes de desarrollador Embed content in apps y Service principals can call Fabric public APIs para la aplicación (portal de administración, configuración del inquilino), la aplicación debe ser Miembro o Administrador de cada área de trabajo que muestre, y los informes necesitan una capacidad Embedded, Fabric o Premium en producción.

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.

Añada embed_origin de la respuesta a la lista de dominios permitidos de la aplicación conectada y habilite el secreto. Cualquiera que tenga un ticket de pantalla puede incrustar cualquier vista que ese usuario pueda ver, así que use un usuario que solo vea los paneles de las pantallas. Tableau Cloud, o Tableau Server 2023.3 o posterior.

Para una página web con inicio de sesión (kind web): la cuenta de servicio de un sitio que muestra su panel tras un inicio de sesión. config.login_mode es auto (config.login_url, config.username y la contraseña como secret: el renderizador abre la página de inicio de sesión y rellena el formulario), steps (config.login_url y config.steps, un script de pasos goto, fill, click, press, wait_for y wait_ms cuyos valores pueden contener {{username}}, {{password}} y {{otp}}) o none (sin inicio de sesión: la conexión muestra páginas con las cookies que usted le da). totp_secret es la clave base32, o la dirección otpauth://, de la aplicación de autenticación de la cuenta: el servidor calcula el código de un solo uso (RFC 6238) y envía al renderizador solo el código. cookies es un conjunto de cookies exportado de un navegador con la sesión iniciada, para un sitio cuyo inicio de sesión no se puede automatizar (inicio de sesión único que se aprueba en un teléfono, una comprobación de dispositivo); el servidor guarda el conjunto y lo renueva con las cookies que devuelve cada captura, así que un inicio de sesión es raro.

La contraseña, la semilla y las cookies se sellan y nunca se devuelven. Use una cuenta de servicio de solo lectura. La contraseña se escribe solo en config.login_url y en los pasos goto, así que moverlos a otro origen exige secret de nuevo. Tras cinco inicios de sesión rechazados seguidos, la conexión deja de iniciar sesión hasta que cambian sus credenciales.

Un servidor sin renderizador de páginas responde bi_web_unavailable. Añade bi_connection.created. Un reintento exacto con la misma Idempotency-Key devuelve esta misma respuesta.

Una conexión, con su última prueba.

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.

Un cambio de dirección o de secreto borra last_test y retira todos los renders en caché de sus vistas. Agrega bi_connection.updated. If-Match protege la revisión.

Elimina una conexión que ninguna vista usa; mientras la usen vistas, la respuesta es resource_conflict con sus ids. Agrega bi_connection.deleted. If-Match protege la revisión.

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).

No juzga los permisos por panel, el estado de las fuentes de datos ni la accesibilidad de un renderizador remoto: pruebe una vista para renderizar de verdad. Un rechazo de Grafana es una comprobación fallida, no un error.

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.

Lista lo que puede mostrar el token de la conexión. Grafana: sus paneles (query busca en los títulos; next_cursor pagina) o, con dashboard definido, los paneles de ese panel (filas aplanadas) bajo dashboard.

Power BI: las áreas de trabajo que la aplicación puede ver (id, name; query conserva los nombres que la contienen) o, con workspace definido, los informes de esa área de trabajo (id, name, embed_url) bajo workspace.

Tableau: las vistas que el usuario de la conexión puede ver (ruta como Workbook/View, name), 100 por página leída; query conserva las vistas cuyo nombre o ruta lo contiene, leyendo hasta diez páginas para encontrarlas, y next_cursor es la siguiente página que leer. Una conexión web no lista nada.

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.

Agrega una vista de un panel de Grafana de la conexión o de uno solo de sus paneles (url: una dirección /d/{uid}/... en el host de la conexión, o target), o de un enlace de panel público de Grafana (kind grafana y target.public_url, sin conexión).

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.

La página de inserción solo muestra un ticket que lleva el manifiesto de la pantalla, así que una vista solo se reproduce en las pantallas de su propio proyecto.

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.

Una visualización de Tableau Public es una vista sin conexión (kind tableau, target.public_url, reconstruida como https://public.tableau.com/views/WORKBOOK/VIEW) y también acepta rotate_sheets. Para una página web (kind web): una página del sitio de la conexión web (url: una dirección https en un host público, sin target).

El navegador en el borde la abre con la sesión iniciada, espera el elemento wait_for si está definido y wait_ms milisegundos (hasta 10000), y dibuja clip, un selector CSS, si está definido, o si no la página entera.

La imagen se redibuja cada refresh_s (60 a 86400, 300 por defecto) y la comparten todas las pantallas del mismo tamaño, y solo mientras una pantalla muestra la vista; cuando falla una captura, la última imagen sigue en pantalla. Defina wait_for con un elemento que solo exista cuando la página tiene la sesión iniciada, para que nunca se muestre una página de inicio de sesión. Añade bi_view.created.

Una vista, con embed_url y cómo le fue la última vez en pantalla (status).

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.

Elimina una vista. Una pantalla que aún muestra su embed_url responde not_found en pantalla hasta que cambie su lista de reproducción. Agrega bi_view.deleted. If-Match protege la revisión.

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.

Una vista de conexión de Power BI genera un token de inserción real para su informe (comprueba report y embed_token); no juzga las páginas que nombra, la capacidad ni lo que muestra el informe, y Power BI rechaza con su propio mensaje un conjunto de datos con seguridad a nivel de fila, que se muestra en la comprobación. Se descarga un enlace público de Power BI y se leen sus encabezados de incrustación.

Una vista de conexión de Tableau inicia sesión como el usuario de la conexión y busca la vista (comprueba signin y view); no juzga la lista de dominios permitidos, el permiso de inserción ni lo que muestra la vista. Una vista de Tableau Public pregunta a Tableau Public si existe el libro y no juzga el nombre de la vista.

Dibuja ahora una vista de Grafana o web como PNG (una vista de Power BI o Tableau responde not_found), fuera de la caché compartida, de modo que una prueba muestra exactamente lo que Grafana o el navegador renderiza a ese tamaño. La propia página de inserción usa el renderizado compartido.