List runs of all reports
- 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/runs
The runs that ended of every report the user can see, of any type, newest first, each with its report, for questions such as what failed overnight: pass status failed and since. Same fields as listReportRuns. Answers up to limit runs, 20 by default and 200 at most, and a nextCursor: pass it as cursor for the next page, until it is null.
Requires the slide_decks:read scope.
Operation ID: listRuns.
Query parameters
limit(integer): Maximum number of runs to return on this page, from 1 to 200. Defaults to20.cursor(string): Where to continue the list: pass thenextCursorreturned with the previous page to get the next one. Omit it for the first page. Example:6c1f9a2e-3b4d-4e8f-9a1b-2c3d4e5f6a7b.status(string): Only the runs that ended this way, such asfailed, asstatusin the runs. If omitted, every run. One ofsucceeded,partiallySucceeded,failed,cancelled,inactive,skipped.since(string (date-time)): Only what happened at or after this time, as an ISO 8601 date and time in UTC, such as2026-11-08T18:00:00Z. If omitted, from the start. Example:2026-11-08T18:00:00Z.
Response 200
Success
application/json
data(array of object, required): The runs that ended of every report you can see, of any type, newest first, whoever started them. To find what failed overnight, passstatusfailedandsince. A run still going isn't listed until it ends.id(string, required): Identifies the run in the history.status(string, required): How the run ended.succeeded: it refreshed everything.partiallySucceeded: it refreshed some of the report and failed the rest, which kept its previous data.failed: nothing could be refreshed, or the run stopped on an error.errorsays why.cancelled: it was stopped before it finished.skipped: it had nothing to refresh, such as a report with no datasheets, or a variant no longer valid for its burst.inactive: nothing it could refresh was active.
One of
succeeded,partiallySucceeded,failed,cancelled,inactive,skipped.trigger(string, required):scheduledwhen one of the report's schedules started it;manualwhen someone started it, in the app, withstartReportRun, or by approving an update the slides agent proposed. One ofmanual,scheduled.startedBy(object or null, required): The member whose run it was.nullif their account was deleted.id(number, required): The member's user id, the same as theiridinlistMembers.name(string, required): The member's name, as shown in Rollstack.email(string, required): The member's email address.
startedAt(string (date-time), required): When the run started.finishedAt(string (date-time), required): When the run ended.error(string or null, required): Why the run failed or stopped, as shown in the app.nullwhen the run recorded no error.failedVisualizations(array of object, required): On a report whosetypeisn'tSlideDeck, up to 20 visualizations the run could not refresh, with the reason; they kept their previous data. Always empty on aSlideDeckreport, whose runs don't record their datasheets:listReportDatasheetsgives each datasheet'serrorfrom its latest update.name(string, required)message(string, required)
updatedSlidesCount(number or null, required): How many slides the run changed.nullwhen the run did not count them.report(object, required): The report the run updated.id(string, required): The report'sid, to pass to the/reports/{id}endpoints, such asgetReport.name(string or null, required): The report's name.
nextCursor(string or null, required): Pass it ascursorto get the next page of runs.nullwhen there are no more.