Skip to main content

List report datasheets

GET https://api.rollstack.com/public/v1/reports/{id}/datasheets

The datasheets a report's charts and tables are built from, with their source and when each was last read. An entry whose copyOf is set repeats an earlier datasheet of the report, with the same sources and steps: it shows the same data and is read together with it, so count each piece of data once by skipping the entries with a copyOf. Only a datasheet a slide shows has a lastBuiltAt.

Requires the slide_decks:read scope.

Operation ID: listReportDatasheets.

Path parameters

  • id (string, required): The report to act on, by its id from listReports or createReport. Only reports whose type is SlideDeck work here: another type, such as a Google Slides presentation, returns 400. You can also copy it from the report's link in Rollstack: it's the part right after /slides/.

Response 200

Success

application/json: array of object

  • id (string, required): Unique identifier for the datasheet. Pass it as datasheetId to getReportDatasheetData to read its table (a data datasheet only), in datasheetIds on startReportRun to update only some datasheets, or in datasheetIds on sendReportMessage for the slides agent to use it.
  • kind (string, required): What the datasheet holds. data: a table, which getReportDatasheetData reads. picture: a picture of a dashboard, tab or chart, such as a dashboard added with addReportDatasheets, with no table to read. The slides agent can still use it when you pass it in datasheetIds on sendReportMessage, and addReportDashboardElements adds the charts of a Tableau or Power BI one as data. One of data, picture.
  • name (string, required): The datasheet's name, as shown in the report's editor, where editors can rename it. A datasheet added with addReportDatasheets starts out named after its uploaded file, its dashboard or dashboard tab, or its range, such as A1:F20.
  • sourceType (string or null, required): The kind of source the datasheet reads; when it reads several, the kind of the first.

    • Looker, Tableau, Metabase, PowerBI, Lightdash, Omni, Sigma: data from that BI tool, such as a dashboard, a tab or one of its charts.
    • Salesforce: a Salesforce report.
    • Snowflake, Databricks, BigQuery: a query run on that warehouse connection, or a table connected for the slides agent.
    • GoogleSheet, GoogleExcel, MicrosoftExcel: a sheet or range of a Google Sheets file, an Excel file in Google Drive, or an Excel file in OneDrive or SharePoint.
    • CsvUpload: a CSV file uploaded with createDataset or in the report's editor.
    • XlsxUpload: a sheet or range of an Excel workbook uploaded to Rollstack.
    • ManualTable: values typed into the report's editor, or the data of a chart imported from PowerPoint.

    Datasheets don't read RollstackVariable or Dbt sources, so expect none of them here. null when the datasheet reads no source, or Rollstack no longer has a record of its first source; deleting an uploaded file or a connection doesn't make it null.

    One of GoogleSheet, GoogleExcel, MicrosoftExcel, Tableau, Salesforce, Metabase, PowerBI, Looker, RollstackVariable, Lightdash, Omni, Sigma, Snowflake, Databricks, BigQuery, CsvUpload, XlsxUpload, ManualTable, Dbt.

  • sourceName (string or null, required): The name of what the datasheet reads, such as a dashboard tab, a range like A1:F20, or an uploaded file. When it reads several sources, the first one's. null in the same cases as sourceType.
  • datasetId (string or null, required): The uploaded file the datasheet reads, by the id replaceDataset takes, when its sourceType is CsvUpload or XlsxUpload. Replace the file, then start a run of the report, to bring new data into the slides drawn from it. Pass it in copyFiles on duplicateReport to give a copy of the report its own copy of the file. null for every other source.
  • spreadsheetId (string or null, required): The spreadsheet the datasheet reads, by Rollstack's id, when its sourceType is GoogleSheet, GoogleExcel or MicrosoftExcel. Pass it in copyFiles on duplicateReport to give a copy of the report its own copy of the file. It can be another member's spreadsheet, which getSpreadsheet doesn't open. null for every other source.
  • lastReadAt (string (date-time) or null, required): When Rollstack last read the datasheet's source successfully and stored a fresh copy of its data; for a datasheet that reads several sources, the latest such read of any of them. null until a read succeeds.
  • lastBuiltAt (string (date-time) or null, required): When the datasheet's data was last applied to the report's slides, updating the charts, tables and pictures drawn from it. It is also set when only some of the elements drawn from it couldn't show the data (see error), since the others were updated. null when its current data hasn't been applied to the slides yet, for example while nothing in the report uses the datasheet.
  • copyOf (string or null, required): When this datasheet is a copy of an earlier one of the report, with the same sources, steps and filter values, that one's id. Several elements can show one datasheet, but a report can still hold copies, for example from before that, or made when elements or reports were duplicated. Copies are read from the source together, once, and show the same data: read and change the original. null for a datasheet that is no copy.
  • error (string or null, required): Why the datasheet's latest update failed, while reading its source or applying its data to the slides, as a human-readable message. When the data couldn't be read, or couldn't be applied to any element, the slides keep showing the datasheet's last good data until an update succeeds. When only some elements couldn't show the data, those keep their last good data and the others show the new data, and lastBuiltAt is set. null when the latest update worked.