Get burst settings
- 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
GET https://api.rollstack.com/public/v1/bursts/{id}/settings
A burst's settings, as its Settings tab in the app shows them: how its variants are named, and for an older report's burst, how each variant's run updates its file, what it does with empty charts, how it archives and how its filters match. Its folders and schedules are set in the app.
Requires the slide_decks:read scope.
Operation ID: getBurstSettings.
Path parameters
id(string, required): The burst to act on, by itsidfromlistBursts. You can also copy it from the burst's link in Rollstack: it's the part right after/collections/.
Response 200
Success
application/json
kind(string, required): What the burst's variants differ by, askindinlistBursts. One ofparameters,filters.variantNaming(string, required): How each variant's report is named from the burst's name and the name the variant is added with,EMEAin a burst namedRegional Review:suffixgivesRegional Review - EMEA,prefixgivesEMEA - Regional Review, andsameNamegivesEMEA. It applies to variants added from then on. One ofsameName,prefix,suffix.updateMethod(string, required): How each variant's run changes its file.updateupdates the same file with the latest data.archivefirst saves a copy of the file, named with the date of its previous run, then updates the original.updateVisualizationsis the method email reports are created with. It applies to new variants and to the existing ones. For an older report's burst only: a Rollstack report's burst returns 400. One ofupdate,archive,updateVisualizations.variantEmptyVisualizations(string, required): What a variant's run does with a chart or table that has no data for its values.showplaces it empty,hideNoCascadeleaves it out of the file,hideCascadehides its slide when every visualization on the slide is empty, andhideCascadeIfAtLeastOneVisualizationIsEmptyhides its slide when any of them is. For an older report's burst only: a Rollstack report's burst returns 400. One ofshow,hideNoCascade,hideCascade,hideCascadeIfAtLeastOneVisualizationIsEmpty.archiveVariantsInFolder(boolean, required): WithupdateMethodarchive: whether each variant's archived copies go in an archive folder next to its file, rather than beside it. For an older report's burst only: a Rollstack report's burst returns 400.datestampSuffix(string, required): WithupdateMethodarchive: the date format added to the name of each archived copy. For an older report's burst only: a Rollstack report's burst returns 400.caseInsensitiveFilters(boolean, required): Whether a variant's filter values match the dashboard's values whatever their case. It applies when filters are next applied, such as withreapplyBurstFilters. For an older report's burst only: a Rollstack report's burst returns 400.