Skip to main content

Search models

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

The models of a Looker, Power BI or Tableau connection whose name or group holds any word of query or its singular, in any case, at most 50: Looker explores grouped by LookML model, Power BI semantic models by workspace, Tableau published data sources by project, read with the user's access to the connection (on Tableau, their own Tableau user). A model is what the slides agent queries in its BI tool for the data a slide needs, where a dashboard tab comes in as a picture. Confirm the model with the user, then add it to a report with addReportDatasheets by its modelId and pass the new datasheet's id to sendReportMessage. listConnections gives the connection's type and id.

Requires the connections:read scope.

Operation ID: searchModels.

Path parameters

  • type (string, required): The type of connection, as type in listConnections. Only Looker, Power BI (PowerBI) and Tableau connections have models: Looker explores, Power BI semantic models and Tableau published data sources. One of Looker, PowerBI, Tableau.
  • 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 model in its BI tool, as searchModels lists it. Pass it as modelId to addReportDatasheets.
  • name (string, required): The model's name, as the app lists it: a Looker explore's label, else its name, a Power BI semantic model's or a Tableau data source's name.
  • group (string, required): What the app lists it under: the LookML model of a Looker explore, the workspace of a Power BI semantic model, the project of a Tableau data source.
  • description (string or null, required): A Looker explore's description from its LookML. null when it has none, and for Power BI and Tableau.