Skip to navigation
Sigma REST APIWorkbooks{workbookId}

List elements in a workbook

View as Markdown

This endpoint retrieves all elements in a workbook, which lets you understand and interact with the individual components that make up the workbook, such as charts, tables, or controls.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • To retrieve elements from version-tagged workbooks, pass the tagName in the query parameters with the tag name. Retrieve the tag name by calling the /v2/workbooks endpoint and using the tags.name included in the response for a given workbook.
  • To retrieve elements from a saved view (formerly called a bookmark), pass the bookmarkId in the query parameters. Retrieve the bookmarkId by calling the /v2/workbooks/{workbookId}/bookmarks or /v2/workbooks/{workbookId}/tags/:tagName/bookmarks endpoints.

Usage scenarios

  • Detailed analysis: Developers and users can retrieve specific elements for detailed data analysis or further manipulation.
  • Interface customization: Allows for dynamic interface construction where users can choose which elements to display or interact with.

Best practices

  • Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience.
  • Validate both the workbookId and pageId to ensure they correspond to valid, accessible resources before making API calls.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.

Query parameters

pagestringOptional
Use to specify further pages using the string returned in the nextPage portion of the response.
limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

tagNamestringOptional
bookmarkIdstringOptional

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

Response

The response body.
entrieslist of objects
nextPagestring or null
totaldoubleOptional