---
title: "Generate Sigma Embed URL"
method: POST
path: "/v2/sigma/generate-embed-url"
tags: ["sigma"]
---

# Generate Sigma Embed URL

`POST /v2/sigma/generate-embed-url`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/sigma/generate-embed-url`
- Auth: HTTP bearer

Generate a signed Sigma embed URL for the requested content, scoped to
the caller's organization and business units via warehouse row-level
security. `business_unit_ids` narrows the session to the selected units;
a restricted user may only select units within their own scope. Cash App
organizations are served the Cash App counterpart of the requested
dashboard, and GBP organizations the GBP counterpart.
The URL is a bearer credential until it expires — never log it.

## Request body

- GenerateSigmaEmbedUrlRequest: Request schema for generating a Sigma embed URL.
  - `content_path` string, required: Sigma content path to embed. Must be one of the analytics-dashboard workbooks, e.g. 'workbook/Workbook-Analytics-Dashboard-V2-New-Overview-...'. Cash App organizations are served the Cash App counterpart of the requested dashboard and GBP organizations the GBP counterpart; the returned URL reflects this.
  - `business_unit_ids` string[], nullable: Business units selected in the analytics filter. The embedded session is scoped to these units (within the caller's permission); omit for the caller's full scope.

## Response `200`

Successful Response

- SigmaEmbedUrlResponse: Response schema for a Sigma embed URL.
  - `embed_url` string, required: Fully-formed Sigma embed URL, ready for an iframe src.
  - `expires_at` integer, required: Unix-seconds expiry of the embedded session; refresh the URL before this time.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/stuut/apis/stuut-api.md) - [All operations](https://skmtc.dev/stuut/apis/stuut-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stuut/apis/stuut-api/revisions/ff0ad16a55ff?raw)