-
Notifications
You must be signed in to change notification settings - Fork 268
docs: Add changelog for new dashboard & widgets APIs (incl. CLI & MCP server) #3328
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
171b5b5
docs: Add changelog for new dashboard & widgets APIs (incl. CLI & MCP…
LysanderKie 7f53d2f
docs: Add Lysander Kiesel to team and authors, fix changelog author
LysanderKie 3036f0c
docs: Remove header media placeholder from dashboard API changelog
LysanderKie 7646a36
Merge branch 'main' into docs/dashboard-and-widget-api-launch
LysanderKie e816244
docs: Document dashboard API/CLI/MCP management on custom dashboards …
LysanderKie File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
content/changelog/2026-07-17-dashboard-and-widget-operations-in-api.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| date: 2026-07-17 | ||
| title: Manage dashboards via API, CLI, and MCP | ||
| description: Create and manage dashboards and widgets programmatically through the public API and Langfuse CLI, let AI agents build them via the Langfuse MCP server, or ask the Langfuse Assistant in the UI. | ||
| author: Lysander | ||
| --- | ||
|
|
||
| import { ChangelogHeader } from "@/components/changelog/ChangelogHeader"; | ||
| import { Book, Code, LayoutDashboard } from "lucide-react"; | ||
|
|
||
| <ChangelogHeader /> | ||
|
|
||
| You can now create and manage dashboards end-to-end in code and your agent. New endpoints under `/api/public/unstable` cover dashboards, the placements on their grid, and the reusable widgets those placements reference. The [Langfuse CLI](/docs/api-and-data-platform/features/cli) picks the endpoints up automatically, and the [Langfuse MCP server](/docs/api-and-data-platform/features/mcp-server) exposes the same operations as tools. | ||
|
Check warning on line 13 in content/changelog/2026-07-17-dashboard-and-widget-operations-in-api.mdx
|
||
|
|
||
| This opens up a few workflows beyond the dashboard editor in the UI: | ||
|
|
||
| - **Dashboards as code**: keep dashboard definitions in version control and apply the same monitoring setup across projects and environments. | ||
| - **Agent-built dashboards**: ask an AI agent for a dashboard, e.g. error traces for a certain feature over time. Reads run automatically, and every change goes through human-in-the-loop approval. | ||
| - **Incremental edits**: add, move, or resize a single tile through the placement endpoints without resubmitting the whole layout. Omit the position and the server appends the tile for you. | ||
|
|
||
| The same tools power the [Langfuse Assistant](/docs/langfuse-assistant) in the UI, so you can ask it to create or update dashboards and widgets directly. The Assistant is available when AI features are enabled for your organization (org admins can enable them in the organization settings). | ||
|
|
||
| ## New endpoints [#new-endpoints] | ||
|
|
||
| - `/dashboards` — list, create, read, update, and delete dashboards, including their filters and full layout definition. See the [dashboards API reference](https://api.reference.langfuse.com/#tag/unstabledashboards). | ||
| - `/dashboards/{dashboardId}/placements` — add, move or resize, and remove individual tiles on a dashboard's grid, documented alongside the [dashboards API reference](https://api.reference.langfuse.com/#tag/unstabledashboards). | ||
| - `/dashboard-widgets` — list, create, read, update, and delete the reusable widgets that placements reference. See the [dashboard widgets API reference](https://api.reference.langfuse.com/#tag/unstabledashboardwidgets). | ||
|
|
||
| ## New MCP tools [#new-mcp-tools] | ||
|
|
||
| <table className="[&_code]:rounded-full [&_code]:border [&_code]:border-border [&_code]:bg-muted [&_code]:px-2 [&_code]:py-1 [&_code]:text-muted-foreground"> | ||
| <tbody> | ||
| <tr> | ||
| <td className="px-3"> | ||
| <strong>Dashboards</strong> | ||
| <div className="mt-2 flex flex-wrap gap-x-3 gap-y-2 leading-3"> | ||
| <code>listDashboards</code> | ||
| <code>getDashboard</code> | ||
| <code>createDashboard</code> | ||
| <code>updateDashboard</code> | ||
| <code>deleteDashboard</code> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td className="px-3"> | ||
| <strong>Placements</strong> | ||
| <div className="mt-2 flex flex-wrap gap-x-3 gap-y-2 leading-3"> | ||
| <code>addDashboardPlacement</code> | ||
| <code>updateDashboardPlacement</code> | ||
| <code>deleteDashboardPlacement</code> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td className="px-3"> | ||
| <strong>Widgets</strong> | ||
| <div className="mt-2 flex flex-wrap gap-x-3 gap-y-2 leading-3"> | ||
| <code>listDashboardWidgets</code> | ||
| <code>getDashboardWidget</code> | ||
| <code>createDashboardWidget</code> | ||
| <code>updateDashboardWidget</code> | ||
| <code>deleteDashboardWidget</code> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| <Callout type="info"> | ||
| These endpoints and MCP tools are **unstable** and may change while the | ||
| dashboard and widget contract is being finalized. The dashboard editor in the | ||
| UI remains fully supported. | ||
| </Callout> | ||
|
|
||
| ## Get started | ||
|
|
||
| <Cards num={3}> | ||
| <Card | ||
| title="Custom dashboards" | ||
| href="/docs/metrics/features/custom-dashboards" | ||
| icon={<LayoutDashboard />} | ||
| arrow | ||
| /> | ||
| <Card | ||
| title="API reference" | ||
| href="https://api.reference.langfuse.com/#tag/unstabledashboards" | ||
| icon={<Code />} | ||
| arrow | ||
| /> | ||
| <Card | ||
| title="MCP server documentation" | ||
| href="/docs/api-and-data-platform/features/mcp-server" | ||
| icon={<Book />} | ||
| arrow | ||
| /> | ||
| </Cards> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.