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
Find, create and manage reports. A report lives in a folder, has one owner, and is shared with other members who can view or edit it. Each report answers the permission the user has on it and a link that opens it in Rollstack.
To act on many reports in one call, batchGetReports, batchStartReportRuns, batchShareReports and batchUpdateReportSchedules take up to 50 at once. Each answers one result per report, done or failed with the error the call for that report alone would answer, so you know which ones to retry.
Most reports are slide decks built in Rollstack, whose type is SlideDeck. Older reports update a file in Google Drive or OneDrive, such as a Google Slides presentation, or send an email. Every report can be listed, read, renamed, moved, deleted, shared, scheduled, run and emailed, and the syncs of an older report listed. An older report that updates a Google Slides presentation or a PowerPoint file converts into a slide deck with convertReport. The other /reports/{id} endpoints take SlideDeck reports only, as their id says, and return 400 for other types.
To fill a new report, add its data in Datasheets, then ask the slides agent in Chat. To bring in an existing PowerPoint or Google Slides deck with its slides, pass its link to createReport. To refresh an existing report, start a run.
List reports
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.
Create report
POST https://api.rollstack.com/public/v1/reports
Creates a report of type SlideDeck, in a folder the user can see when folderId is set. It starts empty, in the look of a saved template from listTemplates when templateId is set, or of another report when templateDeckId is set: its theme, masters and layouts, without its slides. Ask the user which template to use when the organization has company templates. With link, it imports an existing deck instead, with its slides: a PowerPoint file in OneDrive or SharePoint, or a Google Slides presentation, read with the user's own Microsoft or Google account. Rollstack can open only the Google Slides presentations the user picked in Rollstack before, so a link to one they never did answers 422. Over REST, it also imports a PowerPoint (.pptx) file sent as multipart/form-data in the file field, with name and folderId as fields beside it; a report imported from a file is named after it unless name is set. An import answers once the deck is in, which can take a minute for a large one: send an Idempotency-Key (MCP: idempotencyKey) so a retry doesn't import it twice. At most 10 imports a minute per user.
Requires the slide_decks:write scope.
Operation ID: createReport.
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, required
application/json
name(string): Name for the report, as members will see it in Rollstack. Leading and trailing spaces are removed, and it can't be blank. If omitted, a report imported withlinktakes its file's name, and an empty report is named Untitled report until the slides agent names it as it builds the deck, as in the app. Example:Q3 business review.folderId(string): The folder to create the report in, by itsidfromlistFolders; it must be one you can see. Members with access to the folder can then open the report too, with the access the folder gives them. If omitted, the report is created at the top level, outside any folder. Example:a3d5e7f9-1b2c-4d6e-8f0a-1b2c3d4e5f6a.templateDeckId(string): An existing report whose design the new report starts with, by itsidfromlistReports: its theme, slide masters, layouts and slide size, but none of its slides or data. Itstypemust beSlideDeck, and you need at least view access to it. If neither this,templateIdnorlinkis set, the report starts with no slides and Rollstack's default theme and layouts. Example:6c1f9a2e-3b4d-4e8f-9a1b-2c3d4e5f6a7b.templateId(string): A saved template the new report starts with, by itsidfromlistTemplates: a company template or Rollstack's own. The report gets its theme, slide masters, layouts and slide size, with no slides. Leave outtemplateDeckIdwhen you set it. Example:rollstack-signature.link(string): A link to an existing deck to import, as its Share or Copy link button gives it: a PowerPoint (.pptx) file in OneDrive or SharePoint, or a Google Slides presentation. The report starts with its slides and look: a PowerPoint file's charts come in as charts with their data, and a Google Slides presentation's as pictures. The file stays as it is. It is read with the user's own Microsoft or Google account, connected in the app, so they must be able to open it, and Rollstack can open only the Google Slides presentations the user picked in Rollstack before. The report keeps the deck's look, so leave outtemplateIdandtemplateDeckId. Example:https://contoso.sharepoint.com/:p:/s/Finance/EbXqT9kLmNpQrStUvWxYz.
multipart/form-data
file(string (binary), required): The PowerPoint file, a.pptxof at most 100 MB. The endpoint says what it takes from the file and how it names what it makes.name(string): Name for the report, as members will see it in Rollstack. If omitted, it takes the file's name without.pptx. Example:Q3 business review.folderId(string): The folder to create the report in, by itsidfromlistFolders; it must be one you can see. Members with access to the folder can then open the report too, with the access the folder gives them. If omitted, the report is created at the top level, outside any folder. Example:a3d5e7f9-1b2c-4d6e-8f0a-1b2c3d4e5f6a.
Response 201
Success
application/json
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.notificationMailingList(array of string, required): Email addresses Rollstack copies when it emails the owner about a failed scheduled run, whilenotifyOnFailureistrue. Change the list withupdateReport.schedules(array of object, required): The report's schedules: when Rollstack runs the report on its own to update it with fresh data. Empty if it has none, in which case the report only runs when someone starts a run. Replace them withupdateReportSchedules.id(string, required): Unique identifier for the schedule.updateReportSchedulesreplaces every schedule, so the ids change each time you call it.frequency(string, required): How often the schedule runs.hourlyruns every day at each time inselectedTimes.daily,weekly,monthlyandquarterlyrun whenevercronExpressionfires; those made in the app run every day, on chosen weekdays, on chosen days of the month, or every three months, respectively.yearlycan't be set through the API or the app, and also runs oncronExpression. One ofdaily,weekly,monthly,quarterly,hourly,yearly.cronExpression(string, required): When the schedule runs, as a five-field cron expression (minute, hour, day of month, month, day of week) in the schedule'stimezone. For anhourlyschedule, Rollstack generates it fromselectedTimesand runs the report at those times instead. Monthly schedules made in the app can useLand#, such as0 9 L * *(last day of the month) or0 9 ? * 1#1(first Monday).selectedTimes(array of string, required): The times of day anhourlyschedule runs, every day, as 24-hourHH:mmin the schedule'stimezone. Other frequencies don't use it; it's empty on those set through the API.startDate(string (date-time), required): When the schedule starts: it never runs the report before this date and time. This is a local date and time in the schedule'stimezone, written as if it were UTC:2026-11-02T09:00:00Zmeans 9:00 on November 2, 2026 in that timezone, not 9:00 UTC.endDate(string (date-time) or null, required): When the schedule ends: it never runs the report after this date and time.nullif the schedule never ends. LikestartDate, this is a local date and time in the schedule'stimezone, written as if it were UTC.timezone(string, required): The timezone the schedule runs in. Its run times (cronExpressionorselectedTimes),startDateandendDateare all local times in this timezone, so a schedule set for 9:00 keeps running at 9:00 local time when daylight saving time starts or ends. Given as an IANA timezone name, such asAmerica/New_York.syncIds(array of string or null, required): The syncs, fromlistReportSyncs, that the schedule updates on a report other than aSlideDeck.nullwhen it updates the whole report, which a slide deck always does.nextRunAt(string (date-time) or null, required): When the schedule will next run the report.nullif it has no runs left before itsendDate. UnlikestartDateandendDate, this is an actual UTC time.
sharedWith(array of object, required): Members the report is shared with directly, with their access. Members who can open it through its folder aren't listed. Change this list withshareReportandunshareReport.userId(number, required): The member's user id. Pass it asuserIdtoshareReportto change their access, or tounshareReportto remove it.email(string, required): The member's email address, as shown in Rollstack.name(string, required): The member's name, as shown in Rollstack.permission(string, required): What the member can do with the report.viewlets them open, export and duplicate it.commentalso lets them add, reply to and resolve comments on its slides.editalso lets them change its slides, data, schedules, email and other settings, run it, send its email, chat with the slides agent about it, and manage who it's shared with. Neither lets them delete the report or transfer its ownership. One ofview,comment,edit.
Get report
GET https://api.rollstack.com/public/v1/reports/{id}
A report of any type with its schedules, who it is shared with and who is emailed when a run fails. lastRunStatus and running tell how its latest run went and whether one is going, and appUrl opens it in Rollstack. type tells which other endpoints work on it.
Requires the slide_decks:read scope.
Operation ID: getReport.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.
Response 200
Success
application/json
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.notificationMailingList(array of string, required): Email addresses Rollstack copies when it emails the owner about a failed scheduled run, whilenotifyOnFailureistrue. Change the list withupdateReport.schedules(array of object, required): The report's schedules: when Rollstack runs the report on its own to update it with fresh data. Empty if it has none, in which case the report only runs when someone starts a run. Replace them withupdateReportSchedules.id(string, required): Unique identifier for the schedule.updateReportSchedulesreplaces every schedule, so the ids change each time you call it.frequency(string, required): How often the schedule runs.hourlyruns every day at each time inselectedTimes.daily,weekly,monthlyandquarterlyrun whenevercronExpressionfires; those made in the app run every day, on chosen weekdays, on chosen days of the month, or every three months, respectively.yearlycan't be set through the API or the app, and also runs oncronExpression. One ofdaily,weekly,monthly,quarterly,hourly,yearly.cronExpression(string, required): When the schedule runs, as a five-field cron expression (minute, hour, day of month, month, day of week) in the schedule'stimezone. For anhourlyschedule, Rollstack generates it fromselectedTimesand runs the report at those times instead. Monthly schedules made in the app can useLand#, such as0 9 L * *(last day of the month) or0 9 ? * 1#1(first Monday).selectedTimes(array of string, required): The times of day anhourlyschedule runs, every day, as 24-hourHH:mmin the schedule'stimezone. Other frequencies don't use it; it's empty on those set through the API.startDate(string (date-time), required): When the schedule starts: it never runs the report before this date and time. This is a local date and time in the schedule'stimezone, written as if it were UTC:2026-11-02T09:00:00Zmeans 9:00 on November 2, 2026 in that timezone, not 9:00 UTC.endDate(string (date-time) or null, required): When the schedule ends: it never runs the report after this date and time.nullif the schedule never ends. LikestartDate, this is a local date and time in the schedule'stimezone, written as if it were UTC.timezone(string, required): The timezone the schedule runs in. Its run times (cronExpressionorselectedTimes),startDateandendDateare all local times in this timezone, so a schedule set for 9:00 keeps running at 9:00 local time when daylight saving time starts or ends. Given as an IANA timezone name, such asAmerica/New_York.syncIds(array of string or null, required): The syncs, fromlistReportSyncs, that the schedule updates on a report other than aSlideDeck.nullwhen it updates the whole report, which a slide deck always does.nextRunAt(string (date-time) or null, required): When the schedule will next run the report.nullif it has no runs left before itsendDate. UnlikestartDateandendDate, this is an actual UTC time.
sharedWith(array of object, required): Members the report is shared with directly, with their access. Members who can open it through its folder aren't listed. Change this list withshareReportandunshareReport.userId(number, required): The member's user id. Pass it asuserIdtoshareReportto change their access, or tounshareReportto remove it.email(string, required): The member's email address, as shown in Rollstack.name(string, required): The member's name, as shown in Rollstack.permission(string, required): What the member can do with the report.viewlets them open, export and duplicate it.commentalso lets them add, reply to and resolve comments on its slides.editalso lets them change its slides, data, schedules, email and other settings, run it, send its email, chat with the slides agent about it, and manage who it's shared with. Neither lets them delete the report or transfer its ownership. One ofview,comment,edit.
Update report
PATCH https://api.rollstack.com/public/v1/reports/{id}
Renames a report of any type, moves it, or changes its timezone or failure notifications. Renaming a report that updates a file, such as a Google Slides presentation, also renames the file, as the app does. Only its editors may.
Requires the slide_decks:write scope.
Operation ID: updateReport.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. 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, required
application/json
name(string): New name for the report, as members will see it in Rollstack. Leading and trailing spaces are removed, and it can't be blank. Example:Q3 business review.folderId(string or null): The folder to move the report to, by itsidfromlistFolders; it must be one you can see. Passnullto move it to the top level, outside any folder. Members then get access to the report through the new folder, and the folders it's in, instead of the old one. Example:a3d5e7f9-1b2c-4d6e-8f0a-1b2c3d4e5f6a.timezone(string): The report's new timezone. 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, it's also the timezone of the file's date variables, unless the organization'stimezonereplaces it. It doesn't change the report's schedules, which each have their owntimezone: change those withupdateReportSchedules. An IANA timezone name, such asAmerica/New_York. Example:America/New_York.notifyOnFailure(boolean): Whether Rollstack should email the report's owner when a scheduled run fails or some of its datasheets fail to refresh, copying everyone innotificationMailingList. Set it tofalseto stop these emails. Runs started in the app or withstartReportRunnever send them.notificationMailingList(array of string (email)): Email addresses to copy when Rollstack emails the owner about a failed scheduled run, whilenotifyOnFailureistrue. The list you send replaces the current one; send[]to clear it. Each address must belong to an active member of the organization, ignoring case. Up to 100 addresses, with no duplicates.
Response 200
Success
application/json
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.notificationMailingList(array of string, required): Email addresses Rollstack copies when it emails the owner about a failed scheduled run, whilenotifyOnFailureistrue. Change the list withupdateReport.schedules(array of object, required): The report's schedules: when Rollstack runs the report on its own to update it with fresh data. Empty if it has none, in which case the report only runs when someone starts a run. Replace them withupdateReportSchedules.id(string, required): Unique identifier for the schedule.updateReportSchedulesreplaces every schedule, so the ids change each time you call it.frequency(string, required): How often the schedule runs.hourlyruns every day at each time inselectedTimes.daily,weekly,monthlyandquarterlyrun whenevercronExpressionfires; those made in the app run every day, on chosen weekdays, on chosen days of the month, or every three months, respectively.yearlycan't be set through the API or the app, and also runs oncronExpression. One ofdaily,weekly,monthly,quarterly,hourly,yearly.cronExpression(string, required): When the schedule runs, as a five-field cron expression (minute, hour, day of month, month, day of week) in the schedule'stimezone. For anhourlyschedule, Rollstack generates it fromselectedTimesand runs the report at those times instead. Monthly schedules made in the app can useLand#, such as0 9 L * *(last day of the month) or0 9 ? * 1#1(first Monday).selectedTimes(array of string, required): The times of day anhourlyschedule runs, every day, as 24-hourHH:mmin the schedule'stimezone. Other frequencies don't use it; it's empty on those set through the API.startDate(string (date-time), required): When the schedule starts: it never runs the report before this date and time. This is a local date and time in the schedule'stimezone, written as if it were UTC:2026-11-02T09:00:00Zmeans 9:00 on November 2, 2026 in that timezone, not 9:00 UTC.endDate(string (date-time) or null, required): When the schedule ends: it never runs the report after this date and time.nullif the schedule never ends. LikestartDate, this is a local date and time in the schedule'stimezone, written as if it were UTC.timezone(string, required): The timezone the schedule runs in. Its run times (cronExpressionorselectedTimes),startDateandendDateare all local times in this timezone, so a schedule set for 9:00 keeps running at 9:00 local time when daylight saving time starts or ends. Given as an IANA timezone name, such asAmerica/New_York.syncIds(array of string or null, required): The syncs, fromlistReportSyncs, that the schedule updates on a report other than aSlideDeck.nullwhen it updates the whole report, which a slide deck always does.nextRunAt(string (date-time) or null, required): When the schedule will next run the report.nullif it has no runs left before itsendDate. UnlikestartDateandendDate, this is an actual UTC time.
sharedWith(array of object, required): Members the report is shared with directly, with their access. Members who can open it through its folder aren't listed. Change this list withshareReportandunshareReport.userId(number, required): The member's user id. Pass it asuserIdtoshareReportto change their access, or tounshareReportto remove it.email(string, required): The member's email address, as shown in Rollstack.name(string, required): The member's name, as shown in Rollstack.permission(string, required): What the member can do with the report.viewlets them open, export and duplicate it.commentalso lets them add, reply to and resolve comments on its slides.editalso lets them change its slides, data, schedules, email and other settings, run it, send its email, chat with the slides agent about it, and manage who it's shared with. Neither lets them delete the report or transfer its ownership. One ofview,comment,edit.
Delete report
DELETE https://api.rollstack.com/public/v1/reports/{id}
Deletes a report of any type. A report that updates a file, such as a Google Slides presentation, leaves its file where it is. Only its owner may.
Requires the slide_decks:write scope.
Operation ID: deleteReport.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. 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.
Response 204
Success, no content
Convert report to slide deck
POST https://api.rollstack.com/public/v1/reports/{id}/conversions
Turns an older report of type GoogleSlides or MicrosoftPowerPoint, which updates a Google Slides presentation or a PowerPoint file in OneDrive or SharePoint, into a new report of type SlideDeck, as Convert to Rollstack slides in the app does. The new report gets the file's slides, and each sync that can be converted becomes a datasheet reading the same source, drawn by a tile where the sync's chart, table or picture was. The older report and its file stay as they are. The file is read with the older report's owner's account. Answers the new report and what became of each sync, with the reason for one not converted, such as a burst variant's or one of a source with no datasheets: a converted chart with needsRun stays empty until the new report's first run, so start one with startReportRun. Only the older report's editors may. It answers once the conversion ends, which can take a few minutes for a large report: send an Idempotency-Key (MCP: idempotencyKey) so a retry doesn't convert it twice. Counts against the 10 imports a minute per user.
Requires the slide_decks:write scope.
Operation ID: convertReport.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. 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
name(string): Name for the new report, as members will see it in Rollstack. Leading and trailing spaces are removed, and it can't be blank. If omitted, it takes the older report's name. Example:Q4 business review.folderId(string): The folder to put the new report in, by itsidfromlistFolders; it must be one you can add reports to. If omitted, it goes at the top level, as in the app. Example:a3d5e7f9-1b2c-4d6e-8f0a-1b2c3d4e5f6a.
Response 201
Success
application/json
report(object, required): The new report, of typeSlideDeck.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.notificationMailingList(array of string, required): Email addresses Rollstack copies when it emails the owner about a failed scheduled run, whilenotifyOnFailureistrue. Change the list withupdateReport.schedules(array of object, required): The report's schedules: when Rollstack runs the report on its own to update it with fresh data. Empty if it has none, in which case the report only runs when someone starts a run. Replace them withupdateReportSchedules.id(string, required): Unique identifier for the schedule.updateReportSchedulesreplaces every schedule, so the ids change each time you call it.frequency(string, required): How often the schedule runs.hourlyruns every day at each time inselectedTimes.daily,weekly,monthlyandquarterlyrun whenevercronExpressionfires; those made in the app run every day, on chosen weekdays, on chosen days of the month, or every three months, respectively.yearlycan't be set through the API or the app, and also runs oncronExpression. One ofdaily,weekly,monthly,quarterly,hourly,yearly.cronExpression(string, required): When the schedule runs, as a five-field cron expression (minute, hour, day of month, month, day of week) in the schedule'stimezone. For anhourlyschedule, Rollstack generates it fromselectedTimesand runs the report at those times instead. Monthly schedules made in the app can useLand#, such as0 9 L * *(last day of the month) or0 9 ? * 1#1(first Monday).selectedTimes(array of string, required): The times of day anhourlyschedule runs, every day, as 24-hourHH:mmin the schedule'stimezone. Other frequencies don't use it; it's empty on those set through the API.startDate(string (date-time), required): When the schedule starts: it never runs the report before this date and time. This is a local date and time in the schedule'stimezone, written as if it were UTC:2026-11-02T09:00:00Zmeans 9:00 on November 2, 2026 in that timezone, not 9:00 UTC.endDate(string (date-time) or null, required): When the schedule ends: it never runs the report after this date and time.nullif the schedule never ends. LikestartDate, this is a local date and time in the schedule'stimezone, written as if it were UTC.timezone(string, required): The timezone the schedule runs in. Its run times (cronExpressionorselectedTimes),startDateandendDateare all local times in this timezone, so a schedule set for 9:00 keeps running at 9:00 local time when daylight saving time starts or ends. Given as an IANA timezone name, such asAmerica/New_York.syncIds(array of string or null, required): The syncs, fromlistReportSyncs, that the schedule updates on a report other than aSlideDeck.nullwhen it updates the whole report, which a slide deck always does.nextRunAt(string (date-time) or null, required): When the schedule will next run the report.nullif it has no runs left before itsendDate. UnlikestartDateandendDate, this is an actual UTC time.
sharedWith(array of object, required): Members the report is shared with directly, with their access. Members who can open it through its folder aren't listed. Change this list withshareReportandunshareReport.userId(number, required): The member's user id. Pass it asuserIdtoshareReportto change their access, or tounshareReportto remove it.email(string, required): The member's email address, as shown in Rollstack.name(string, required): The member's name, as shown in Rollstack.permission(string, required): What the member can do with the report.viewlets them open, export and duplicate it.commentalso lets them add, reply to and resolve comments on its slides.editalso lets them change its slides, data, schedules, email and other settings, run it, send its email, chat with the slides agent about it, and manage who it's shared with. Neither lets them delete the report or transfer its ownership. One ofview,comment,edit.
conversion(object or null, required): What became of the older report's syncs, or null when converting them failed.converted(array of object, required): The syncs that are now tiles on the slides, each drawn from a datasheet.syncId(string, required): The sync of the older report, aslistReportSyncslists it.name(string, required): The sync's name.datasheetId(string, required): The datasheet that now reads its source.slideId(string, required): The slide whose tile now shows it.needsRun(boolean, required): Whether its chart stays empty until the new report's first run reads the datasheet's data.
notPlaced(array of object, required): The syncs that got a datasheet, but no tile: the slides agent can build one from the datasheet.syncId(string, required): The sync of the older report, aslistReportSyncslists it.name(string, required): The sync's name.datasheetId(string, required): The datasheet that now reads its source.reason(string, required): Why no element of the slides could show it.
notConverted(array of object, required): The syncs left as they were in the new report's slides, such as a burst variant's.syncId(string, required): The sync of the older report, aslistReportSyncslists it.name(string, required): The sync's name.reason(string, required): Why it was not converted.
conversionError(string or null, required): Why the syncs could not be converted, when they couldn't. The new report still exists with the file's slides, so don't convert the report again.
Duplicate report
POST https://api.rollstack.com/public/v1/reports/{id}/duplicates
Copies a report of type SlideDeck with its slides, datasheets and email setup, as Duplicate in the app does, and answers the copy, which you own. Its schedules and direct shares are copied only when asked. Only members who may duplicate the report may: view access is enough. Each call makes another copy.
Requires the slide_decks:write scope.
Operation ID: duplicateReport.
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/.
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, required
application/json
name(string, required): Name for the copy, as members will see it in Rollstack. Leading and trailing spaces are removed, and it can't be blank. Example:Q4 business review.folderId(string): The folder to put the copy in, by itsidfromlistFolders; it must be one you can add reports to. If omitted, the copy goes in the report's own folder, or for a burst's variant, in the burst's folder. Example:a3d5e7f9-1b2c-4d6e-8f0a-1b2c3d4e5f6a.copySchedules(boolean): Also give the copy the report's schedules, so it updates on its own at the same times. Defaults tofalse.inheritSharing(boolean): Also share the copy with everyone the report is shared with directly, at the same permission. Defaults tofalse, so only you can open it until you share it. Defaults tofalse.
Response 201
Success
application/json
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.notificationMailingList(array of string, required): Email addresses Rollstack copies when it emails the owner about a failed scheduled run, whilenotifyOnFailureistrue. Change the list withupdateReport.schedules(array of object, required): The report's schedules: when Rollstack runs the report on its own to update it with fresh data. Empty if it has none, in which case the report only runs when someone starts a run. Replace them withupdateReportSchedules.id(string, required): Unique identifier for the schedule.updateReportSchedulesreplaces every schedule, so the ids change each time you call it.frequency(string, required): How often the schedule runs.hourlyruns every day at each time inselectedTimes.daily,weekly,monthlyandquarterlyrun whenevercronExpressionfires; those made in the app run every day, on chosen weekdays, on chosen days of the month, or every three months, respectively.yearlycan't be set through the API or the app, and also runs oncronExpression. One ofdaily,weekly,monthly,quarterly,hourly,yearly.cronExpression(string, required): When the schedule runs, as a five-field cron expression (minute, hour, day of month, month, day of week) in the schedule'stimezone. For anhourlyschedule, Rollstack generates it fromselectedTimesand runs the report at those times instead. Monthly schedules made in the app can useLand#, such as0 9 L * *(last day of the month) or0 9 ? * 1#1(first Monday).selectedTimes(array of string, required): The times of day anhourlyschedule runs, every day, as 24-hourHH:mmin the schedule'stimezone. Other frequencies don't use it; it's empty on those set through the API.startDate(string (date-time), required): When the schedule starts: it never runs the report before this date and time. This is a local date and time in the schedule'stimezone, written as if it were UTC:2026-11-02T09:00:00Zmeans 9:00 on November 2, 2026 in that timezone, not 9:00 UTC.endDate(string (date-time) or null, required): When the schedule ends: it never runs the report after this date and time.nullif the schedule never ends. LikestartDate, this is a local date and time in the schedule'stimezone, written as if it were UTC.timezone(string, required): The timezone the schedule runs in. Its run times (cronExpressionorselectedTimes),startDateandendDateare all local times in this timezone, so a schedule set for 9:00 keeps running at 9:00 local time when daylight saving time starts or ends. Given as an IANA timezone name, such asAmerica/New_York.syncIds(array of string or null, required): The syncs, fromlistReportSyncs, that the schedule updates on a report other than aSlideDeck.nullwhen it updates the whole report, which a slide deck always does.nextRunAt(string (date-time) or null, required): When the schedule will next run the report.nullif it has no runs left before itsendDate. UnlikestartDateandendDate, this is an actual UTC time.
sharedWith(array of object, required): Members the report is shared with directly, with their access. Members who can open it through its folder aren't listed. Change this list withshareReportandunshareReport.userId(number, required): The member's user id. Pass it asuserIdtoshareReportto change their access, or tounshareReportto remove it.email(string, required): The member's email address, as shown in Rollstack.name(string, required): The member's name, as shown in Rollstack.permission(string, required): What the member can do with the report.viewlets them open, export and duplicate it.commentalso lets them add, reply to and resolve comments on its slides.editalso lets them change its slides, data, schedules, email and other settings, run it, send its email, chat with the slides agent about it, and manage who it's shared with. Neither lets them delete the report or transfer its ownership. One ofview,comment,edit.
Get reports in a batch
POST https://api.rollstack.com/public/v1/reports/batch-get
Up to 50 reports of any type at once, each as getReport answers it, with its schedules, who it is shared with, how its latest run went and whether one is going. Answers one result per report, each naming its id: a report you can't see fails on its own, with the error getReport would answer, and the others still answer.
Requires the slide_decks:read scope.
Operation ID: batchGetReports.
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, required
application/json
ids(array of string, required): The reports to act on, of anytype, by theiridfromlistReports. From 1 to 50 ids; an id listed twice is acted on once.
Response 200
Success
application/json
results(array of object, required): One result per report, each naming itsid.When
statusisdoneid(string, required): The report, by itsidfromids.status(done, required): The call succeeded on this report.result(object, required): The report, asgetReportanswers it.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.notificationMailingList(array of string, required): Email addresses Rollstack copies when it emails the owner about a failed scheduled run, whilenotifyOnFailureistrue. Change the list withupdateReport.schedules(array of object, required): The report's schedules: when Rollstack runs the report on its own to update it with fresh data. Empty if it has none, in which case the report only runs when someone starts a run. Replace them withupdateReportSchedules.id(string, required): Unique identifier for the schedule.updateReportSchedulesreplaces every schedule, so the ids change each time you call it.frequency(string, required): How often the schedule runs.hourlyruns every day at each time inselectedTimes.daily,weekly,monthlyandquarterlyrun whenevercronExpressionfires; those made in the app run every day, on chosen weekdays, on chosen days of the month, or every three months, respectively.yearlycan't be set through the API or the app, and also runs oncronExpression. One ofdaily,weekly,monthly,quarterly,hourly,yearly.cronExpression(string, required): When the schedule runs, as a five-field cron expression (minute, hour, day of month, month, day of week) in the schedule'stimezone. For anhourlyschedule, Rollstack generates it fromselectedTimesand runs the report at those times instead. Monthly schedules made in the app can useLand#, such as0 9 L * *(last day of the month) or0 9 ? * 1#1(first Monday).selectedTimes(array of string, required): The times of day anhourlyschedule runs, every day, as 24-hourHH:mmin the schedule'stimezone. Other frequencies don't use it; it's empty on those set through the API.startDate(string (date-time), required): When the schedule starts: it never runs the report before this date and time. This is a local date and time in the schedule'stimezone, written as if it were UTC:2026-11-02T09:00:00Zmeans 9:00 on November 2, 2026 in that timezone, not 9:00 UTC.endDate(string (date-time) or null, required): When the schedule ends: it never runs the report after this date and time.nullif the schedule never ends. LikestartDate, this is a local date and time in the schedule'stimezone, written as if it were UTC.timezone(string, required): The timezone the schedule runs in. Its run times (cronExpressionorselectedTimes),startDateandendDateare all local times in this timezone, so a schedule set for 9:00 keeps running at 9:00 local time when daylight saving time starts or ends. Given as an IANA timezone name, such asAmerica/New_York.syncIds(array of string or null, required): The syncs, fromlistReportSyncs, that the schedule updates on a report other than aSlideDeck.nullwhen it updates the whole report, which a slide deck always does.nextRunAt(string (date-time) or null, required): When the schedule will next run the report.nullif it has no runs left before itsendDate. UnlikestartDateandendDate, this is an actual UTC time.
sharedWith(array of object, required): Members the report is shared with directly, with their access. Members who can open it through its folder aren't listed. Change this list withshareReportandunshareReport.userId(number, required): The member's user id. Pass it asuserIdtoshareReportto change their access, or tounshareReportto remove it.email(string, required): The member's email address, as shown in Rollstack.name(string, required): The member's name, as shown in Rollstack.permission(string, required): What the member can do with the report.viewlets them open, export and duplicate it.commentalso lets them add, reply to and resolve comments on its slides.editalso lets them change its slides, data, schedules, email and other settings, run it, send its email, chat with the slides agent about it, and manage who it's shared with. Neither lets them delete the report or transfer its ownership. One ofview,comment,edit.
When
statusisfailedid(string, required): The report, by itsidfromids.status(failed, required): The call failed on this report and changed nothing on it. The other reports are unaffected.error(object, required): Why this report failed, as the endpoint for one report would answer. Retry only these reports.code(string, required): A stable, machine-readable code for the error, such asapi-key-missing-scopeordata-validation-error. Use it, rather thanmessage, to handle specific errors in your code.message(string, required): A human-readable explanation of what went wrong, to log or show to people. When the request's path parameters, query or body are invalid (data-validation-error), it lists each invalid field by its path, with the problem, such asbody.emails.0: Invalid email address.statusCode(number, required): The HTTP status the same call on this report alone would answer, such as404or403.
Transfer ownership
POST https://api.rollstack.com/public/v1/reports/{id}/transfer-ownership
Makes a member of the organization the owner of a report. Only its owner may, and keeps edit access.
Requires the slide_decks:write scope.
Operation ID: transferReportOwnership.
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/.
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, required
application/json
newOwnerId(integer, required): The member who becomes the report's owner, by user id: theiridinlistMembers, or theiruserIdin the report'ssharedWith. They must be an active member of the organization other than you. The previous owner keepseditaccess to the report, and the new owner is notified. Example:1042.
Response 204
Success, no content