Get report content
- 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}/content
What a viewer sees on a report's visible slides: titles, text, and each chart's and table's values. On a long report, pass slideIds for only the slides you need, such as a reply's changedSlideIds.
Requires the slide_decks:read scope.
Operation ID: getReportContent.
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/.
Query parameters
slideIds(string or array of string): The slides to return, from a reply'schangedSlideIdsor an earliergetReportContentcall. If omitted, every visible slide is returned. Hidden slides and ids that are not slides of the report are ignored. Up to 20 ids: repeat the parameter for each one, as in?slideIds=a&slideIds=b. Example:f1e2d3c4-b5a6-4978-8a1b-2c3d4e5f6a7b.
Response 200
Success
application/json
slides(array of object, required): The report's visible slides in report order, or only those inslideIds. Hidden slides are never included.index(number, required): The slide's position in the report as viewers see it, counting only visible slides and starting at0. It stays the same whenslideIdsnarrows the list.id(string, required): Identifies the slide. Pass it inslideIdstogetReportSlideImagesorexportReport, or tosendReportMessageto tell the slides agent which slides your message is about.title(string or null, required): The slide's title: the text in its title box.nullwhen the slide has no title box, or the box is empty.texts(array of string, required): The text of each text box and shape on the slide, title included. Text from the slide's master and layout is left out, and so are empty boxes.charts(array of object, required): The charts on the slide, with the data each one shows.title(string or null, required): The chart title shown on the slide.nullwhen the chart has no title, and always for a table.type(string, required): What kind of chart it is:bar,lineorpie. A chart that combines kinds, such as bars with a line, takes the kind of its first series, and a chart with no series ischart. Alwaystablefor a table.values(object, required): The data the chart or table shows, ascolumnsandrows.columns(array of string, required): The column headers: for a chart, the names of the data columns it draws; for a table, the text of its first row.rows(array of array of string or number or null, required): The data, one array per row, with its values in the order ofcolumns. A chart's numbers are raw values, before the chart's number format is applied; a table's cells are text. At most 200 rows;truncatedsays whether there were more.truncated(boolean, required): Whether the chart or table has more than 200 rows, in which caserowscontains only the first 200.
tables(array of object, required): The tables on the slide, with the text of their cells. A table's first row is returned as itscolumns, and the other rows as itsrows.title(string or null, required): The chart title shown on the slide.nullwhen the chart has no title, and always for a table.type(string, required): What kind of chart it is:bar,lineorpie. A chart that combines kinds, such as bars with a line, takes the kind of its first series, and a chart with no series ischart. Alwaystablefor a table.values(object, required): The data the chart or table shows, ascolumnsandrows.columns(array of string, required): The column headers: for a chart, the names of the data columns it draws; for a table, the text of its first row.rows(array of array of string or number or null, required): The data, one array per row, with its values in the order ofcolumns. A chart's numbers are raw values, before the chart's number format is applied; a table's cells are text. At most 200 rows;truncatedsays whether there were more.truncated(boolean, required): Whether the chart or table has more than 200 rows, in which caserowscontains only the first 200.