Skip to main content

Export report

POST https://api.rollstack.com/public/v1/reports/{id}/exports

Exports a report as PDF or PowerPoint and answers a download link valid for 15 minutes. At most 10 exports a minute per user.

Requires the slide_decks:read scope.

Operation ID: exportReport.

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/.

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

  • format (string, required): The kind of file to create. pdf is a PDF of the report's visible slides; hidden slides are left out. pptx is a PowerPoint file in which hidden slides are included but stay hidden, speaker notes are kept, and charts are images rather than editable charts. One of pdf, pptx.
  • slideIds (array of string): The slides to export, from getReportContent or a reply's changedSlideIds. The file keeps the report's slide order whatever order you list them in. Ids that are not slides of the report are ignored, and so are hidden slides in a PDF. If omitted, the whole report is exported.

Response 200

Success

application/json

  • url (string, required): A link that downloads the exported file, named after the report. Anyone who has the link can download the file, without an API key, until expiresAt.
  • expiresAt (string (date-time), required): When url stops working, 15 minutes after the export. Export the report again to get a new link.