List 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/reports
The reports the user can see, of every type, newest first. Each report's type tells which endpoints work on it: the slides agent, exports, content, datasheets, parameters, templates, duplicating and ownership transfer take SlideDeck reports only, and syncs take the other types only. You can filter by folderId, name and type; when several are set, all must match, and name matching ignores case. Answers up to limit reports, 50 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: listReports.
Query parameters
folderId(string): Only return reports directly in this folder, by itsidfromlistFolders. Reports in its subfolders aren't included. Example:a3d5e7f9-1b2c-4d6e-8f0a-1b2c3d4e5f6a.name(string): Only return reports whose name contains this text, ignoring case:reviewmatchesQ3 Business Review. Example:business review.type(string): Only return reports of thistype, such asSlideDeckfor the reports that the slides agent, exports and datasheets work on. One ofGoogleDocs,GoogleSlides,MicrosoftPowerPoint,MicrosoftWord,Email,UploadedPPTXFile,SlideDeck. Example:SlideDeck.limit(integer): Maximum number of reports to return on this page, from 1 to 200. Defaults to50.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.
Response 200
Success
application/json
data(array of object, required): The reports on this page, of everytype, most recently created first.id(string, required): Unique identifier for the report. Pass it asidto the other/reports/{id}endpoints.type(string, required): The kind of report, which decides the endpoints that work on it.SlideDeck: a slide deck built in Rollstack. Every/reports/{id}endpoint works on it, exceptlistReportSyncsandconvertReport.GoogleSlides,GoogleDocs,MicrosoftPowerPoint,MicrosoftWord: a file in Google Drive or OneDrive that Rollstack updates with its visualizations.UploadedPPTXFile: a PowerPoint file uploaded to Rollstack, which it updates the same way.Email: an email report, whose visualizations Rollstack sends in an email.
On a report that isn't a
SlideDeck, onlygetReport,updateReport,deleteReport,shareReport,unshareReport,getReportSchedules,updateReportSchedules,startReportRun,listReportRuns,getReportRun,cancelReportRun,listReportSyncsand the email endpoints (getReportEmailConfig,updateReportEmailConfig,listReportEmails,sendReportEmail,sendReportTestEmail) work, andconvertReporton aGoogleSlidesorMicrosoftPowerPointreport. The other/reports/{id}endpoints takeSlideDeckreports only, as theiridsays, and return400.One of
GoogleDocs,GoogleSlides,MicrosoftPowerPoint,MicrosoftWord,Email,UploadedPPTXFile,SlideDeck.name(string, required): Name of the report, as members see it in Rollstack. Change it withupdateReport.folderId(string or null, required): The folder the report is in, by itsidinlistFolders.nullwhen the report is at the top level, outside any folder.owner(object, required): The member who owns the report: whoever created it, unless ownership has since been transferred, in the app or withtransferReportOwnership. Only the owner can delete the report.id(number, required): The owner's user id, the same as theiridinlistMembers.name(string, required): The owner's name, as shown in Rollstack.email(string, required): The owner's email address. Rollstack emails this address when a scheduled run of the report fails, whilenotifyOnFailureistrue.
permission(string or null, required): Your access to the report, as the user the API key belongs to.viewlets you open and export it, and see its datasheets, runs, schedules and email setup.commentalso lets you add, reply to and resolve comments on its slides.editalso lets you change it: rename or move it, chat with the slides agent about it, add datasheets and read their data, start runs, set its schedules and email, send its email, and share it. It's nevernullhere, since the API only returns reports you can at least view. One ofview,comment,edit.timezone(string or null, required): The report's timezone, such asAmerica/New_York. The slides agent uses it to tell today's date, and the report's emails show the time of its last successful update ({{last_updated_at}}) in it. On a report that updates a file, such as a Google Slides presentation, it's also the timezone of the file's date variables, unless the organization'stimezonereplaces it. Schedules don't use it: each has its owntimezone.nullwhen the report has none, in which case the slides agent uses UTC. Reports created withcreateReportstart with the organization'stimezonefromgetOrganization, if it has one.notifyOnFailure(boolean, required): Whether Rollstack emails the report's owner when a scheduled run fails or some of its datasheets, or a file's visualizations, fail to refresh, copying everyone innotificationMailingList. Runs started in the app or withstartReportRunnever send this email. New reports start withtrue.lastSyncedAt(string (date-time) or null, required): When the report's latest run ended, whatever its outcome.nullif the report has never run.lastSuccessfulUpdateAt(string (date-time) or null, required): When the report's latest fully successful run ended: one that refreshed every datasheet it ran on, or every visualization on a report that updates a file, with none failing. Runs with nothing to refresh don't count. The report's emails show this time as{{last_updated_at}}.nulluntil the report has had such a run.lastRunStatus(string or null, required): How the report's latest run ended.completed: it finished, even if some datasheets or visualizations failed to refresh or it had none to refresh; on aSlideDeckreport,listReportDatasheetsshows each datasheet'serror.failed: it stopped on an error, or none of its datasheets or visualizations could be refreshed.cancelled: it was stopped before it finished, for example withcancelReportRun.nullif the report has never run.runningandtimed_outnever appear here: checkrunningto see whether a run is in progress. One ofrunning,completed,failed,cancelled,timed_out.running(boolean, required): Whether a run of the report is in progress, whoever started it, such as you withstartReportRun, a member in the app, or one of its schedules. While it'strue,startReportRunreturns that run instead of starting another.appUrl(string (uri), required): Link that opens the report in Rollstack.fileUrl(string or null, required): Link that opens the Google Slides, Google Docs, PowerPoint or Word file the report updates.nullfor a slide deck, an email report or an uploaded PowerPoint file, which have no file to open, and for a Microsoft file whose link Rollstack has not read yet.createdAt(string (date-time), required): When the report was created.listReportsreturns the newest first.updatedAt(string (date-time), required): When the report's details last changed, such as its name, folder or owner, or the outcome of its latest run.
nextCursor(string or null, required): Pass it ascursorto get the next page of reports.nullwhen there are no more.