Skip to main content

Get report design

GET https://api.rollstack.com/public/v1/reports/{id}/design

Start here to design a slide deck's slides yourself, as HTML. A call without layoutIds answers the guide to writing a slide for this report, which you follow, and what a slide is drawn on: the canvas size, the theme colours and, when the report has a template, its layouts by name. Call it again with layoutIds for the layouts you will use, to get the box each one's title goes in and the areas to keep clear.

Requires the slide_decks:read scope.

Operation ID: getReportDesign.

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

Query parameters

  • layoutIds (string or array of string): The layouts to describe in full, by their id from a first call without it. At most 10: repeat the parameter for each one, as in ?layoutIds=a&layoutIds=b. Left out, only the template's style is described.

Response 200

Success

application/json

  • canvas (object, required): The report's slide size in CSS pixels. A slide's <section> is exactly this large.
    • width (number, required)
    • height (number, required)
  • theme (array of object, required): The report's theme colours. A slide uses these and no others.
    • variable (string, required): The CSS variable a slide names the colour by, as in var(--accent1).
    • hex (string, required): The colour it stands for in this report.
  • layouts (array of object, required): The layouts of the report's template. Empty when the report has no template of its own: lay slides out freely then.
    • id (string, required): The id a slide names the layout by, as data-layout-id on its <section>.
    • name (string, required): The layout's name in the template.
    • type (string or null, required): The layout's kind in the template, such as title or obj, when it has one.
  • layoutDetails (string or null, required): How to write on the template, as Markdown: the type and colours its slides are set in, and for each layout named in layoutIds the box its title goes in, its other placeholders with their ids and boxes, and the areas to keep clear. Null when the report has no template of its own.
  • guide (string): How to write a slide for this report, as Markdown: the HTML a slide is made of, the styles that are kept, how to place charts, tables and figures from its datasheets, and how to check and save it. Read it before writing any slide. Only on a call without layoutIds.