STstuut
sigma

Generate Sigma Embed URL

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.

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)
  • Auth
    HTTP bearer

Request body

content_pathstring 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_idsstring[] 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

Successful Response

embed_urlstring required

Fully-formed Sigma embed URL, ready for an iframe src.

expires_atinteger required

Unix-seconds expiry of the embedded session; refresh the URL before this time.

Changes

No recorded changes to this operation across all 1 revision of this API.