URL Parameters
The embedding URL supports various parameters to customize the dashboard appearance and functionality. All parameters use kebab-case naming convention.Required Parameters
| Parameter | Description | Example |
|---|---|---|
embedding-token | Embedding token | Z0FBQ... |
workspace-id | The workspace identifier | dIwIBPYdGmWS |
dashboard-id | The dashboard id | dIwIBPYmWS |
Display Options
| Parameter | Type | Default | Description |
|---|---|---|---|
show-toolbar | boolean | true | Show/hide the chat toolbar |
show-header | boolean | true | Show/hide the dashboard header |
show-nav | boolean | false | Show/hide navigation elements |
show-screenshot | boolean | true | Enable/disable screenshot functionality |
Dashboard Controls
| Parameter | Type | Default | Description |
|---|---|---|---|
show-dashboard-select | boolean | false | Show dashboard selector dropdown |
generate-dashboard | boolean | false | Enable dashboard generation features |
edit-mode | boolean | false | Enable edit mode for dashboard |
edit-layout | boolean | false | Enable layout editing |
edit-chart | boolean | false | Enable chart editing |
delete-chart | boolean | false | Enable chart deletion |
pin-chart | boolean | false | Enable chart pinning |
Chat Features
| Parameter | Type | Default | Description |
|---|---|---|---|
chat-composer | boolean | true | Show chat composer |
show-chat-toolbar | boolean | true | Show chat toolbar |
Appearance
| Parameter | Type | Options | Default | Description |
|---|---|---|---|---|
theme | string | light, dark, system | light | Dashboard theme |