API: Embedding
Embed tokens and domain allowlists. All endpoints require authentication unless noted. 6 endpoints.
GET /api/embed-config
Section titled “GET /api/embed-config”Get embed configuration for workspace
Responses: 200 · 400 · 401 · 404
PUT /api/embed-config
Section titled “PUT /api/embed-config”Update embed configuration for workspace
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
allowedOrigins |
array of string | no | |
defaultTheme |
string | no | |
customCss |
string | no | |
logoUrl |
string | no | |
showToolbar |
boolean | no | |
allowExport |
boolean | no |
Responses: 200 · 400 · 401 · 404
GET /api/embed-tokens
Section titled “GET /api/embed-tokens”List embed tokens for company
Responses: 200 · 400 · 401
POST /api/embed-tokens
Section titled “POST /api/embed-tokens”Generate an embed token
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
contentType |
"dashboard" | "report" |
yes | |
contentId |
string | yes | |
name |
string | no | |
rlsContext |
object | no | |
expiresAt |
string | no |
Responses: 201 · 400 · 401 · 409
DELETE /api/embed-tokens/{id}
Section titled “DELETE /api/embed-tokens/{id}”Revoke an embed token
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Responses: 204 — No content · 401 · 404
GET /api/embed-usage
Section titled “GET /api/embed-usage”Embed usage rollups per share
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
days |
integer | no |
Responses: 200