Sigma Computing Documentation

Retrieve details of a workbook bookmark.

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.
Retrieve the bookmarkId by calling the /v2/workbooks/{workbookId}/bookmarks endpoint.

Retrieve details of a workbook bookmark. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

bookmarkIdstringRequired

Response

The response body.

bookmarkIdstring

namestring

isSharedboolean

Whether the bookmark is shared.

exploreKeystring

ID of the associated exploration.

isDefaultboolean

Whether the bookmark is default.

1	{
2	"bookmarkId": "bkmk-9f8a7c6d5e4f3a2b1c0d",
3	"name": "Q2 Sales Overview",
4	"isShared": true,
5	"exploreKey": "explore-4a3b2c1d0e9f8a7b6c5d",
6	"isDefault": false
7	}