Add a saved view to a tagged workbook

View as Markdown
Add a saved view (formerly called a bookmark) to a version-tagged 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](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response. - Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-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 on a tagged version:** Persist filters, controls, or layout changes against a tagged workbook version. - **Share a view:** Set `isShared` to `true` to make the saved view available to other members who can access the workbook.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.
tagNamestringRequired

Request

The request body.
workbookVersiondoubleRequired
namestringRequired
isSharedbooleanRequired
Whether the saved view is shared.
exploreKeystringRequired
ID of the associated custom view.

Response

The response body.
bookmarkIdstring
namestring
isSharedboolean
Whether the saved view is shared.
exploreKeystring
ID of the associated custom view.
isDefaultbooleanOptional
Whether this saved view is the default view for the workbook.