Get a saved view in a tagged workbook

GET

/v2/workbooks/:workbookId/tags/:tagName/bookmarks/:bookmarkId

Retrieve details of a saved view (formerly called a bookmark) in a tagged workbook.

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.
Retrieve the tagName by calling the /v2/tags endpoint and using the name in the response.
Retrieve the bookmarkId by calling the /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks endpoint.

Usage scenarios

Inspect a saved view: Retrieve the name, sharing, default status, and associated custom view (exploreKey) on a tagged workbook version.

Retrieve details of a saved view (formerly called a bookmark) in a tagged workbook. ### 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 **bookmarkId** by calling the [/v2/workbooks/{workbookId}/tags/{tagName}/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoint. ### Usage scenarios - **Inspect a saved view:** Retrieve the name, sharing, default status, and associated custom view (`exploreKey`) on a tagged workbook version.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Unique identifier of the workbook.

tagNamestringRequired

bookmarkIdstringRequired

Unique identifier of the saved view (formerly called a bookmark).

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.