Get dashboard
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/connections/{type}/{id}/dashboards/{dashboardId}
A dashboard of a Looker, Metabase, Omni, Lightdash, Sigma, Tableau or Power BI connection, read with the user's access to the connection (a Salesforce report has no tabs or charts to read, so add it with addReportDatasheets directly): its tabs, and the charts and filters of the tab tabId names, one of the ids in tabs (else the one the dashboard opens on, a Power BI report's or Sigma workbook's first page). Tableau and Power BI list no charts or filters here: once the tab is added to a report, its charts are listed from its picture for the slides agent to add; a Sigma page lists its charts and tables, and the workbook's controls as its filters. Find the dashboard's id with searchDashboards. Confirm the dashboard and tab with the user, then add it to a report with addReportDatasheets; for another tab, call it again with that tab's id from tabs.
Requires the connections:read scope.
Operation ID: getDashboard.
Path parameters
type(string, required): The type of connection, astypeinlistConnections: the BI tool it connects to. Only Looker, Metabase, Omni, Lightdash, Sigma, Tableau and Power BI (PowerBI) connections have dashboards. One ofLooker,Metabase,Omni,Lightdash,Tableau,PowerBI,Sigma.id(string, required): Unique identifier for the connection, fromlistConnections, which also returns itstype.dashboardId(string, required): The dashboard to read, by theidthatsearchDashboardsreturns.
Query parameters
tabId(string): The dashboard tab to read, by itsidfrom thetabsthatgetDashboardreturns: a Looker, Metabase or Lightdash tab, a Tableau view, a Power BI page or a Sigma page. If omitted, the dashboard's first tab is used, or the whole dashboard when it has no tabs, as on Omni. A tab the dashboard doesn't have returns a 404 error. Example:12-overview.
Response 200
Success
application/json
connection(object, required): The connection the dashboard was read through: the one in the request path.id(string, required): Unique identifier for the connection, theidin the request path.type(string, required): The data source the connection reads from:Tableau,Looker,Metabase,PowerBI,Lightdash,Omni,SigmaorSalesforce, or theSnowflake,DatabricksorBigQuerydata warehouse. Endpoints that act on a connection take it in their path, with the connection'sid. One ofTableau,Looker,Metabase,PowerBI,Lightdash,Omni,Sigma,Salesforce,Snowflake,Databricks,BigQuery.name(string, required): The connection's name, as members see it in Rollstack.
dashboard(object, required): The dashboard you asked for.id(string, required): Identifies the dashboard in its BI tool. Pass it asdashboardIdtogetDashboardoraddReportDatasheets. For Tableau it is the workbook's id; for Power BI, the report's workspace id and report id, joined by a dot; for Sigma, the workbook's UUID, not the short id in its links. For Salesforce it is a report's id, to pass asreportIdtoaddReportDatasheets; a report has no tabs, sogetDashboarddoesn't read it.name(string, required): The dashboard's name in its BI tool. For Tableau and Sigma it is the workbook's name, for Power BI the report's.url(string, required): A link that opens the dashboard in its BI tool. For Tableau, it opens the workbook on the view intabId; for Sigma, on its first page.
tabs(array of object, required): The dashboard's tabs: a Looker, Metabase or Lightdash dashboard's tabs, a Tableau workbook's views, a Power BI report's pages or a Sigma workbook's pages, never its hidden ones. Empty when the dashboard has no tabs, as always on Omni.id(string, required): Identifies the tab. Pass it astabIdto read that tab withgetDashboard, or to add it to a report withaddReportDatasheets. Its form depends on the BI tool: a Looker layout id, a Metabase{id}-{slug}such as12-overview, a Lightdash tab uuid, a Tableau view id, a Power BI page's internal name or a Sigma page id.name(string, required): The tab's name as shown in the BI tool, such as a Power BI page's display name.
tabId(string or null, required): The tabelementscomes from: the one you passed astabId, or the dashboard's first tab if you passed none.nullwhen the dashboard was read as a whole, as when it has no tabs.elements(array of object, required): The charts and other elements on that tab, or on the whole dashboard whentabIdisnull. Once you add the tab to a report withaddReportDatasheets, the slides agent can add these elements to the report's slides. For Sigma, only the page's charts and tables, without its texts, images and controls. Always empty for Tableau and Power BI: their charts are listed once the tab is added to a report, bygetReportDatasheeton its picture, andaddReportDashboardElementsor the slides agent can then add them.id(string, required): Identifies the element in its BI tool, such as a Looker tile's id, a Metabase dashboard card's id, a Lightdash chart's uuid or a Sigma element's id.name(string, required): The element's title as shown on the dashboard. An element without a title, such as a text card, is named after its type instead, as inText.type(string, required): The kind of element, in the BI tool's own terms, such aslooker_columnfor a Looker column chart,saved_chartfor a Lightdash chart,kpi-chartfor a Sigma KPI ortextfor a Metabase text card.
filters(array of object, required): The dashboard's filters, and on Omni its controls too. For Sigma, the controls on every page of the workbook, so two can share a label. Always empty for Tableau and Power BI.name(string, required): The filter's label as shown on the dashboard. For Metabase it is the filter's slug instead, and for a Sigma control without a label, its control ID.