> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # Get embeds for a workbook GET https://api.sigmacomputing.com/v2/workbooks/{workbookId}/embeds 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](https://help.sigmacomputing.com/reference/list-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. Reference: https://help.sigmacomputing.com/reference/list-workbook-embeds ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/workbooks/{workbookId}/embeds: get: operationId: listWorkbookEmbeds summary: Get embeds for a workbook description: >- 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](https://help.sigmacomputing.com/reference/list-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. tags: - Workbooks parameters: - name: workbookId in: path required: true schema: type: string - name: page in: query required: false schema: type: string - name: limit in: query required: false schema: type: number format: double - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: '#/components/schemas/workbooks_listWorkbookEmbeds_Response_200' servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: schemas: V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItemsSourceType: type: string enum: - workbook - page - element title: >- V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItemsSourceType V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: embedId: type: string description: Unique identifier of the embed. embedUrl: type: string public: type: boolean sourceType: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItemsSourceType sourceId: type: - string - 'null' sourceName: type: - string - 'null' required: - embedId - embedUrl - public - sourceType - sourceId - sourceName title: >- V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItems workbooks_listWorkbookEmbeds_Response_200: type: object properties: entries: type: array items: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItems description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: >- Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: >- Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: workbooks_listWorkbookEmbeds_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Request** ```json {} ``` **Response** ```json { "entries": [ { "embedId": "ebd-9f8c7d6a2b3e4f1a", "embedUrl": "https://app.sigmacomputing.com/embed/workbook/ebd-9f8c7d6a2b3e4f1a?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9", "public": false, "sourceType": "workbook", "sourceId": "wbk-4a5b6c7d8e9f0123", "sourceName": "Sales Performance Q2 2024" } ], "nextPage": null, "total": 1, "hasMore": false } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/workbooks/workbookId/embeds" payload = {} headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/workbooks/workbookId/embeds'; const options = { method: 'GET', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/workbooks/workbookId/embeds" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/workbooks/workbookId/embeds") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sigmacomputing.com/v2/workbooks/workbookId/embeds") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.sigmacomputing.com/v2/workbooks/workbookId/embeds', [ 'body' => '{}', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/workbooks/workbookId/embeds"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/workbooks/workbookId/embeds")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```