Skip to main content

Get the data guide

GET https://api.rollstack.com/public/v1/data-guide

Read this once before you add or shape the data of a report: how to send a CSV or an Excel workbook and pick the range of a sheet, how to check a figure with queryReportData, how to shape data with previewReportDatasheetChanges, renderReportSlides and saveReportDatasheetChanges, and the query model those changes write. It needs no report. With stepFunctions, it also answers the exact params of those step functions, for the steps after a join.

Requires the slide_decks:read scope.

Operation ID: getReportDataGuide.

Query parameters

  • stepFunctions (string or array of string): Step functions whose exact params to answer with the guide, for the steps after a join: repeat the parameter for each, as in ?stepFunctions=filter&stepFunctions=sort.

Response 200

Success

application/json

  • guide (string, required): The guide, in Markdown: how to send a CSV or a workbook, pick a range of a sheet, check a figure with a query, shape data with datasheet changes and save it.
  • stepFunctions (object): Each step function asked for, with its label and the JSON Schema of its params.