Embedded

Get an embedded url for the given user identifier.

post/v1/get_embedded_url

Request body

user_identifierstring required

Embedded user identifier

canvas_idstring nullable

Canvas ID for dashboard embeds

doc_idstring nullable

Doc ID for doc embeds

drive_filestring nullable

Drive path to the data-app .embedded.html artifact. Required when embed_type is 'data_app'.

redirect_query_paramsstring nullable

Optional query params for redirect URL

embed_type'dashboard' | 'route' | 'canvas' | 'doc' | 'data_app' nullable

Embed target type

clear_sessionboolean nullable

Whether to clear prior auth session

timestampinteger nullable

Optional timestamp for request signing

routestring nullable

Route path for route embeds

expires_ininteger nullable

Seconds until the embed token expires. Only used when embed_type is 'data_app'. Defaults to 86400 (24h). Min 60, max 2592000 (30d).

allowed_hostsstring[] nullable

Hostnames allowed to embed the iframe, set as Content-Security-Policy frame-ancestors. Default is allow-all ('*'). Only used when embed_type is 'data_app'.

Response

Success

urlstring required

Embed URL (Supabase magic link for docs, signed direct URL for data apps)

expires_atstring date-time nullable

Timestamp when the token expires; only populated for data_app embeds

Changes

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