Get a datasheet
- 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/reports/{id}/datasheets/{datasheetId}
What a datasheet's data is written as: its query, in the shape set-query takes, its one SQL statement, or its join and the steps after it, and its formats. Read it before you change a datasheet with previewReportDatasheetChanges: set-query replaces the whole query, so start from this one. For the picture of a Tableau view or Power BI page added with addReportDatasheets, it also lists the charts on it, which addReportDashboardElements adds as data. Only the report's editors may.
Requires the slide_decks:read scope.
Operation ID: getReportDatasheet.
Path parameters
id(string, required): The report to act on, by itsidfromlistReportsorcreateReport. Only reports whosetypeisSlideDeckwork here: another type, such as a Google Slides presentation, returns400. You can also copy it from the report's link in Rollstack: it's the part right after/slides/.datasheetId(string, required): One of this report's datasheets, by itsidinlistReportDatasheets.
Response 200
Success
application/json
id(string, required): The datasheet's id.name(string, required): The datasheet's name, as the report's editor shows it.kind(string, required):datafor a table,picturefor an image, which has no query. One ofdata,picture.elements(array of object or null, required): For the picture of a whole Tableau view or Power BI page, the charts on it, whichaddReportDashboardElementsadds as data or pictures.nullfor any other datasheet. Listing them takes the dashboard's picture when it never had one, which can take a minute: past the wait the call answers that the source is still being read, so call it again.ref(string, required): What to pass asreftoaddReportDashboardElementsto add this chart.name(string, required): The chart's name on the dashboard.type(string, required): Its kind in the dashboard's tool, such as a Tableauworksheetorlegend.reads(array of string, required): What it can be added as:datafor its table,picturefor its image.datasheetIds(array of string, required): The report's datasheets that already read it with the dashboard's filters, to use instead of adding it again.
elementsNote(string or null, required): Whyelementsis empty or partial, such as charts not listed yet, ornull.query(object or null, required): Its data as a query, the Edit data editor's model, in the shapeset-querytakes: change what you need and send it whole.nullwhen its data is SQL or a join.sql(string or null, required): Its data as one SQL statement over its reads, ornull.ops(array of object or null, required): For a datasheet that joins its reads: the join and the steps after it, each by therefset-opskeeps it by.nullfor any other.formats(array of object, required): How its columns' numbers are shown: a numfmt pattern for each output column.column(string, required)format(string, required)