Skip to main content

Get cloud save

GET https://api.rollstack.com/public/v1/reports/{id}/cloud-export

Where a report is saved after its runs, in Google Drive, OneDrive or SharePoint, and how its last save went, with a link to the saved file. Answers 404 until it is set up with updateReportCloudExport or in the app's scheduling panel.

Requires the slide_decks:read scope.

Operation ID: getReportCloudExport.

Path parameters

  • id (string, required): The report to act on, by its id from listReports or createReport. Only reports whose type is SlideDeck work here: another type, such as a Google Slides presentation, returns 400. You can also copy it from the report's link in Rollstack: it's the part right after /slides/.

Response 200

Success

application/json

  • provider (string, required): Where the report is saved: google saves it to Google Drive as a Google Slides presentation, with its charts as linked Google Sheets charts, and microsoft saves it to OneDrive or SharePoint as a PowerPoint file with native charts. One of google, microsoft.
  • folder (object, required): The folder the report is saved in.
    • id (string, required): The folder's id in Google Drive, OneDrive or SharePoint.
    • name (string, required): The folder's name.
  • fileName (string, required): The saved file's name.
  • trigger (string, required): Which runs save it: all after every run that doesn't fail, scheduled only after the report's scheduled runs, and none never, which stops saving it and keeps the setting. One of all, scheduled, none.
  • updateMethod (string, required): update replaces the saved file with the new version. archive first copies the saved file, named with the date of its last save in datestampSuffix, then replaces it. One of update, archive, updateVisualizations.
  • datestampSuffix (string, required): How archive dates the copies it keeps, as a moment.js format such as MM/DD/YYYY or YYYY-MM-DD.
  • ignoreFailuresOnArchive (boolean, required): With archive, whether a copy that fails still lets the save go on.
  • fileUrl (string or null, required): A link to the saved file, which its sharing in Google Drive, OneDrive or SharePoint lets people open. null until it is first saved.
  • runsAsUserId (number, required): The member whose Google or Microsoft account saves it, as id in listMembers: the one who last chose its folder.
  • lastStatus (string or null, required): Whether the last save worked. null until it is first saved. A failed one emails the member it runs as. One of success, failed.
  • lastStatusMessage (string or null, required): Why the last save failed. null when it worked.
  • lastExportedAt (string (date-time) or null, required): When the report was last saved. null until it is first saved.