Get embeds for a workbook

This endpoint retrieves the list of available embeds for a specific workbook. The response provides the embedUrl and indicates whether an embed is public.

Usage notes

  • The endpoint requires the workbookId as a path parameter to identify the workbook. Retrieve the workbookId by calling the /v2/workbooks endpoint.

Usage scenarios

  • Integration with third-party applications: Developers can use this endpoint to list embeds that integrate workbook content into third-party applications, enhancing functionality or providing customized views.
  • Internal dashboards: Teams within an organization can embed workbook content into internal dashboards to monitor real-time data and analytics from various workbooks without directly accessing Sigma.

Best practices

  • Ensure that the embeds are used in compliance with data governance and privacy policies.
  • Regularly review and manage the access permissions for each embed to prevent unauthorized data exposure.
Path Params
string
required

Unique identifier of the workbook.

Query Params
string

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

number

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.

Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json