Workbooks

Add a saved view to a workbook

Add a saved view (formerly called a bookmark) to a workbook. A saved view is a named custom view you can return to later or share.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • Retrieve the workbookVersion by calling the /v2/workbooks endpoint and using the latestVersion in the response for the workbook, or from the version history More menu for the specific version.
  • Retrieve the exploreKey by identifying the ID of the custom view that you want to save. When viewing a custom view in a workbook, its explore key is visible in the URL: :explore=76c76e52-8d94-448a-969c-32cc18da9ea0. Provide the ID after the =.

Usage scenarios

  • Save a custom view: Persist filters, controls, or layout changes so you can reopen the same named view later.
  • Share a view: Set isShared to true to make the saved view available to other members who can access the workbook.
post/v2/workbooks/{workbookId}/bookmarks

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

workbookIdstring required

Unique identifier of the workbook.

Request body

workbookVersionnumber double required
namestring required
isSharedboolean required

Whether the saved view is shared.

exploreKeystring required

ID of the associated custom view.

Response

The response body.

bookmarkIdstring required
namestring required
isSharedboolean required

Whether the saved view is shared.

exploreKeystring required

ID of the associated custom view.

isDefaultboolean

Whether this saved view is the default view for the workbook.

Changes

No recorded changes to this operation across all 1 revision of this API.