Skip to main content

Search dashboards

GET https://api.rollstack.com/public/v1/connections/{type}/{id}/dashboards

The dashboards of a Looker, Metabase, Omni, Lightdash, Sigma, Tableau or Power BI connection whose name holds any word of query or its singular, in any case, at most 50: those the most of the organization's reports read first, copies, old and personal ones last, then most words first, read with the user's access to the connection. A Tableau dashboard is a workbook, its views its tabs; a Power BI one a report, its pages its tabs; a Sigma one a workbook, its pages its tabs. On a Sigma connection, query can be a link to a workbook the user pasted: it finds only that workbook, with the page the link opens on as tabId, but not the link's control values, saved view or tag, and a link to another Sigma organization is rejected. On a Salesforce connection it finds reports the same way, the most recently run first among equals, each with its format: a report has no tabs, so add a tabular or summary one to a report with addReportDatasheets by its reportId, without getDashboard, and tell the user a matrix or joined one can't be added yet. Search by the name the user gives, confirm the dashboard with the user, then check its tabs and charts with getDashboard or add it to a report with addReportDatasheets. listConnections gives the connection's type and id.

Requires the connections:read scope.

Operation ID: searchDashboards.

Path parameters

  • type (string, required): The type of connection, as type in listConnections: the BI tool it connects to. Only Looker, Metabase, Omni, Lightdash, Sigma, Tableau and Power BI (PowerBI) connections have dashboards, and on a Salesforce connection the search finds its reports. One of Looker, Metabase, Omni, Lightdash, Tableau, PowerBI, Sigma, Salesforce.
  • id (string, required): Unique identifier for the connection, from listConnections, which also returns its type.

Query parameters

  • query (string): Words to search for in names, separated by spaces: a dashboard, table, model or spreadsheet is returned when its name contains any of them, case-insensitively, a table's full name with its database and schema. If omitted, results aren't filtered by name. At most 50 results are returned either way. Example: revenue.

Response 200

Success

application/json: array of object

  • id (string, required): Identifies the dashboard in its BI tool. Pass it as dashboardId to getDashboard or addReportDatasheets. 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 as reportId to addReportDatasheets; a report has no tabs, so getDashboard doesn'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 and Salesforce the report's.
  • folder (string or null, required): Where the dashboard is filed in its BI tool: its Looker, Omni or Salesforce folder, Metabase collection, Power BI workspace or Sigma path (My Documents for a workbook in your own Sigma documents). Helps tell apart dashboards with the same name, such as copies of a Power BI report in several workspaces. null when the BI tool gives none, and always for Lightdash and Tableau.
  • decks (number, required): How many of your organization's reports have a datasheet that reads from this dashboard through this connection. Results are sorted by this count, highest first.
  • tabId (string): Only for a Sigma workbook found by a link to one of its pages or elements: the page the link opens on, to pass as tabId to getDashboard or addReportDatasheets.
  • tabName (string): Only with tabId: the name of the page the link opens on, as Sigma shows it.
  • format (string): Only for a Salesforce report: its format in Salesforce. Only tabular and summary reports can be added with addReportDatasheets; matrix and joined reports can't be added yet, so tell the user rather than offering them. One of tabular, summary, matrix, joined.