Convert report to slide deck
- 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
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.