List elements in a workbook page

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

Usage notes

• Retrieve the workbookId by calling the /v2/workbooks endpoint.
• Retrieve the pageId by calling the /v2/workbooks/{workbookId}/pages endpoint.
• To retrieve pages from version-tagged workbooks, pass the tag 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 pages from a bookmark (saved view), 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.