Skip to main content

Start report run

POST https://api.rollstack.com/public/v1/reports/{id}/runs

Refreshes a report's data, or only some of its datasheets, then repairs failed calculations and the slides with AI. On a report of another type than SlideDeck, such as a Google Slides presentation, refreshes every sync, or only the syncIds given, instead, as Update in the app does, updating its file when it has one (an Email report has none). A run of the whole report then emails it when its email trigger is all; a run of only some syncIds never does. Answers the run's id at once; while a run of the report is already going, from the API, the app or its schedule, it answers that run's id with started false and starts nothing. Pass repairSlides false to leave the slides as they are, when you wrote them yourself and will check and fix them. From an AI client, a run that emails the report only asks the user to confirm it in Rollstack: it answers confirmation-required and runs once they confirm.

Requires the slide_decks:run scope.

Operation ID: startReportRun.

Path parameters

  • id (string, required): The report to act on, of any type, by its id from listReports or createReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after /slides/ or /destinations/.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Request body

application/json

  • datasheetIds (array of string (uuid)): The datasheets to update, from listReportDatasheets, instead of the whole report. Each must be a datasheet of this report. Unlike a run of the whole report, which reads every source again, a run of only some datasheets reuses the data last read from their sources: it reads a source again only if that data is missing or expired, or what the datasheet reads has changed, such as its source, its filters or the connection it reads with, as when you replace an uploaded file with replaceDataset. If omitted, the run updates the whole report. 1 to 500 ids. Only on reports whose type is SlideDeck: a report of another type has syncs instead, so passing it returns 400.
  • syncIds (array of string (uuid)): The syncs to update, from listReportSyncs, instead of the whole report, such as the ones whose status is failed. Each must be a sync of this report. A paused sync is skipped, as in the app. A run of only some syncs never emails the report. If omitted, the run updates the whole report. 1 to 500 ids. Only on reports other than SlideDeck, which has datasheets instead, so passing it on a slide deck returns 400.
  • repairSlides (boolean): Whether Rollstack repairs the slides with AI once the data is in: failed calculations, and text the new data made wrong. Pass false to read the data only, when you check and fix the slides yourself. If omitted, the slides are repaired. Only on reports whose type is SlideDeck.

Response 202

Success

application/json

  • runId (string, required): Identifies the run. Pass it as runId to getReportRun to follow the run until it ends, or to cancelReportRun to stop it.
  • started (boolean, required): Whether this request started a new run. false when a run of the report was already in progress, whoever started it: through the API, in the app or on one of its schedules. In that case nothing new starts, datasheetIds and syncIds are ignored, and runId is that run's id. To run the report with your request, wait for that run to end with getReportRun, then call startReportRun again.