Skip to main content
Return one dashboard’s full detail: its tile layout and the reports it shows. The natural follow-up to list_dashboards when you need to understand an existing dashboard — not just which reports it groups, but how they are laid out and what each report is built on. On top of the list_dashboards row it adds visualizations (the flat list of chart / pivot tiles), layout (their arrangement, row by row) and reports (the full detail of every distinct report the tiles render — the data table each is built on, its type, who can view it, and its available visualization types). Dashboards have no per-dashboard sharing — you either see all of the company’s dashboards or none, depending on your reporting access. A dashboard you can’t reach is reported as not found.

Parameters

Body

dashboard
string
required
The dashboard to read. Accepts its name (case- and accent-insensitive substring) or its ObjectId. A name matching no — or more than one — dashboard raises a clear error; pass the id to disambiguate.

Response

Body

id
string
resource_url
string
Deep link to open this dashboard in the Qobra web app.
name
string
description
string
updated_at
string
visualizations
object[]
The chart / pivot-table tiles the dashboard shows, each referencing the report it is built on.
layout
object[]
The dashboard’s tile arrangement, top to bottom — each row lists the tiles placed on it, left to right. This is how the visualizations are laid out on the page.
reports
object[]
Full detail of every distinct report the dashboard’s tiles are built on: the reporting data table each is built on, its type, who can view it, and which visualization types it offers. Deduplicated — a report shown as both a chart and a pivot table appears once.