Skip to main content

Update burst settings

PATCH https://api.rollstack.com/public/v1/bursts/{id}/settings

Changes the settings passed and answers them all. A Rollstack report's burst takes only variantNaming. An older report's run settings, such as updateMethod, also apply to its existing variants. Only the burst's owner and admins may.

Requires the slide_decks:write scope.

Operation ID: updateBurstSettings.

Path parameters

  • id (string, required): The burst to act on, by its id from listBursts. You can also copy it from the burst's link in Rollstack: it's the part right after /collections/.

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

  • variantNaming (string): How each variant's report is named from the burst's name and the name the variant is added with, EMEA in a burst named Regional Review: suffix gives Regional Review - EMEA, prefix gives EMEA - Regional Review, and sameName gives EMEA. It applies to variants added from then on. One of sameName, prefix, suffix.
  • updateMethod (string): How each variant's run changes its file. update updates the same file with the latest data. archive first saves a copy of the file, named with the date of its previous run, then updates the original. updateVisualizations is 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 of update, archive, updateVisualizations.
  • variantEmptyVisualizations (string): What a variant's run does with a chart or table that has no data for its values. show places it empty, hideNoCascade leaves it out of the file, hideCascade hides its slide when every visualization on the slide is empty, and hideCascadeIfAtLeastOneVisualizationIsEmpty hides its slide when any of them is. For an older report's burst only: a Rollstack report's burst returns 400. One of show, hideNoCascade, hideCascade, hideCascadeIfAtLeastOneVisualizationIsEmpty.
  • archiveVariantsInFolder (boolean): With updateMethod archive: 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): With updateMethod archive: 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): Whether a variant's filter values match the dashboard's values whatever their case. It applies when filters are next applied, such as with reapplyBurstFilters. For an older report's burst only: a Rollstack report's burst returns 400.

Response 200

Success

application/json

  • kind (string, required): What the burst's variants differ by, as kind in listBursts. One of parameters, filters.
  • variantNaming (string, required): How each variant's report is named from the burst's name and the name the variant is added with, EMEA in a burst named Regional Review: suffix gives Regional Review - EMEA, prefix gives EMEA - Regional Review, and sameName gives EMEA. It applies to variants added from then on. One of sameName, prefix, suffix.
  • updateMethod (string, required): How each variant's run changes its file. update updates the same file with the latest data. archive first saves a copy of the file, named with the date of its previous run, then updates the original. updateVisualizations is 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 of update, archive, updateVisualizations.
  • variantEmptyVisualizations (string, required): What a variant's run does with a chart or table that has no data for its values. show places it empty, hideNoCascade leaves it out of the file, hideCascade hides its slide when every visualization on the slide is empty, and hideCascadeIfAtLeastOneVisualizationIsEmpty hides its slide when any of them is. For an older report's burst only: a Rollstack report's burst returns 400. One of show, hideNoCascade, hideCascade, hideCascadeIfAtLeastOneVisualizationIsEmpty.
  • archiveVariantsInFolder (boolean, required): With updateMethod archive: 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): With updateMethod archive: 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 with reapplyBurstFilters. For an older report's burst only: a Rollstack report's burst returns 400.