Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
742 changes: 533 additions & 209 deletions docs-mintlify/api-reference/api.yaml

Large diffs are not rendered by default.

23 changes: 22 additions & 1 deletion docs-mintlify/api-reference/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@ rss: true
{/* GENERATED FILE — do not edit by hand. */}
{/* Run scripts/extract-changelog.js against the platform client CHANGELOG.md. */}

<Update label="2026-09-02" description="v0.6.0" tags={["Added","Changed","Deprecated"]}>
### Added

- `User` (`GET /api/v1/users/me`, `UsersPublicController.getMe`) gained `userPolicies` — the caller's effective resource policies: direct grants, organization-wide grants and grants inherited from their groups. This is the set the console has always read over GraphQL; on REST it lets an embedded Creator Mode session resolve a workbook another embed user shared with it, which previously granted nothing beyond viewing. New schemas: `Policy`, `PolicyResourceType`.
- Re-added `POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread` (`WorkbooksPublicController.updatePublishedDashboardAiWidgetThread`) and its `UpdatePublishedAiWidgetThreadInput` schema (`widgetId`, `threadId`, optional `checksum`) — reverting the `0.4.0` removal. Regenerating an AI-analysis widget on a **published** dashboard persists the new thread id (+ checksum) back to the published config so an immediate reload shows the fresh result instead of the stale one. It stores **only** the thread id and checksum — never summary text (CUB-4031).
- `PATCH /api/v1/users/me/settings` (`UsersPublicController.updateMySettings`) — merge a partial patch into your own settings; omitted fields are left as they are, and `sheets` merges field-by-field (an explicit `null` clears it). `UserSettingsInput` gained `sheets`. New schema: `SheetsUserSettingsInput` (`autoRunQueryOnChange`, `openExplorationFromSheet`, `revealSheetOnOpen`, `showAppliedFilters`, `suppressDuplicateValues`).
- `POST /api/v1/deployments/{id}/token` (`DeploymentsPublicController.deploymentToken`) now accepts an optional body to request a shorter token lifetime than the 24-hour default. New schema: `CreateDeploymentTokenInput` (`expiresIn`, 60–86400 seconds) — recommended for tokens held outside a browser session (scripts, BI tools, scheduled jobs).
- `AppTheme` / `AppThemeResponse` (`GET /api/v1/app-theme`, `GET /api/v1/app-config`) gained `palette` and `logoUrl` — the new theme model: base/accent color seeds, contrast level, a pastel toggle, surface mode, and per-semantic color overrides (danger/warning/success/note/code). New schemas: `AppThemePalette`, `AppThemePaletteSeed`, `AppThemePaletteThemes`, `AppThemeCodePalette`, `AppThemeSurfaceMode`.
- `DashboardWidgetDtoType` / `DashboardWidgetInputType` gained a new `"FIELD"` enum value, for the Field switcher dashboard control.
- `ReportPlacement` gained `queryChecksum` and `syncStatus` (new schema `ReportPlacementSyncStatus`: `"UP_TO_DATE"` | `"CHANGED"` | `"UNKNOWN"`), and `Report` gained `currentQueryChecksum` — together they let a client tell whether the cells at a placement still reflect the exploration as it stands now.

### Changed

- `POST /api/v1/usage-analytics/token` — corrected docs: tokens expire after 1 hour, not ~24 hours as previously stated. `expiresAt` on the response has always reflected the real value.

### Deprecated

- `AppTheme.light` / `AppTheme.dark` — use `palette` and `logoUrl` instead.
- `UserSettingsInput.lastSeenChangelogId` — ignored; the changelog now arrives in the notification inbox, which carries its own read state. Accepted for backward compatibility but never read or written.
</Update>

<Update label="2026-08-30" description="v0.5.0" tags={["Added"]}>
### Added

Expand Down Expand Up @@ -72,7 +93,7 @@ rss: true

### Removed

- **BREAKING:** `POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread` (`WorkbooksPublicController.updatePublishedDashboardAiWidgetThread`) and its `UpdatePublishedAiWidgetThreadInput` schema (added in `0.2.0`). It persisted an AI-analysis thread id + checksum into the published dashboard config — the mechanism that caused read-only/anonymous viewers to hit `WorkbookEdit`/403s and let one viewer's filter state clobber the shared config (CUB-3898). AI-analysis results are now cached server-side keyed by dashboard state, so no client-facing endpoint replaces it. This is a deliberate breaking removal; SDK consumers referencing the operation or schema should drop those references.
- **BREAKING:** `POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread` (`WorkbooksPublicController.updatePublishedDashboardAiWidgetThread`) and its `UpdatePublishedAiWidgetThreadInput` schema (added in `0.2.0`). It persisted an AI-analysis thread id + checksum into the published dashboard config — the mechanism that caused read-only/anonymous viewers to hit `WorkbookEdit`/403s and let one viewer's filter state clobber the shared config (CUB-3898). AI-analysis results are recovered by replaying the chat thread whose id the dashboard config stores, so no client-facing endpoint replaces it (CUB-4031). This is a deliberate breaking removal; SDK consumers referencing the operation or schema should drop those references.
</Update>

<Update label="2026-07-30" description="v0.3.0" tags={["Added","Changed","Removed"]}>
Expand Down
1 change: 1 addition & 0 deletions docs-mintlify/api-reference/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Resources by entity:
| [Workbooks](/api-reference/workbooks/get-workbooks) | `/api/v1/deployments/{deploymentId}/workbooks` | v1 |
| [Notifications](/api-reference/notifications/list-scheduled-notifications) | `/api/v1/deployments/{deploymentId}/notifications` | v1 |
| [Workspace](/api-reference/workspace/list-shared-workspace-items) | `/api/v1/deployments/{deploymentId}` | v1 |
| [Users](/api-reference/users/update-my-settings) | `/api/v1/users/me/settings` | v1 |
| [Users Admin](/api-reference/users-admin/create-user) | `/api/v1/users` | v1 |
| [User Attributes](/api-reference/user-attributes/get-user-attributes) | `/api/v1/user-attributes` | v1 |
| [User Attribute Values](/api-reference/user-attribute-values/upsert-user-attribute-value) | `/api/v1/user-attribute-values` | v1 |
Expand Down
12 changes: 10 additions & 2 deletions docs-mintlify/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -901,6 +901,7 @@
"PUT /api/v1/deployments/{deploymentId}/workbooks/{workbookId}",
"DELETE /api/v1/deployments/{deploymentId}/workbooks/{workbookId}",
"PUT /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard",
"POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread",
"POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/duplicate",
"POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/publish"
]
Expand Down Expand Up @@ -930,6 +931,13 @@
"POST /api/v1/deployments/{deploymentId}/workspace/move"
]
},
{
"group": "Users",
"openapi": "/api-reference/api.yaml",
"pages": [
"PATCH /api/v1/users/me/settings"
]
},
{
"group": "Users Admin",
"openapi": "/api-reference/api.yaml",
Expand Down Expand Up @@ -1057,7 +1065,7 @@
]
},
{
"group": "Users",
"group": "Users (SCIM)",
"openapi": "/api-reference/scim.yaml",
"pages": [
"GET /scim/v2/Users",
Expand All @@ -1069,7 +1077,7 @@
]
},
{
"group": "Groups",
"group": "Groups (SCIM)",
"openapi": "/api-reference/scim.yaml",
"pages": [
"GET /scim/v2/Groups",
Expand Down
10 changes: 7 additions & 3 deletions docs-mintlify/docs/explore-analyze/dashboards/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,12 @@ title.
PNG and PDF downloads are server-rendered snapshots — Cube re-opens the
dashboard (or, for a single chart, that chart on its own), waits for rendering
to finish, and captures the result. This can take up to a couple of minutes
for large dashboards. The filter and time-grain selections you currently have
applied in your browser are carried into the export. (CSV is generated from the
data already loaded in the chart and downloads immediately.)
for large dashboards. The control selections you currently have applied in your
browser are carried into a download you start yourself — filters, time
granularity switchers and [field switchers][ref-controls] alike. A scheduled
notification has no browser session, so its attachment renders the dashboard's
own defaults, unless that notification carries selections of its own. (CSV is
generated from the data already loaded in the chart and downloads immediately.)

Downloading the whole dashboard requires **Manage** permission on the workbook
that owns it; exporting a single chart requires the **Download data**
Expand All @@ -94,6 +97,7 @@ after a [scheduled refresh][ref-scheduled-refreshes].

[ref-workbooks]: /docs/explore-analyze/workbooks
[ref-widgets]: /docs/explore-analyze/dashboards/widgets
[ref-controls]: /docs/explore-analyze/dashboards/widgets/controls
[ref-dimension-links]: /docs/data-modeling/dimensions#links
[ref-notifications]: /docs/explore-analyze/notifications
[ref-scheduled-refreshes]: /docs/explore-analyze/scheduled-refreshes
Expand Down
20 changes: 19 additions & 1 deletion docs-mintlify/docs/explore-analyze/dashboards/widgets/charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,32 @@ If the picker is empty, create the report first in a workbook tab — only publi

## Interaction with controls

Charts respect the [controls][ref-controls] placed on the same dashboard — filters and time granularity switchers. A single control can drive multiple charts at once: its value is applied to every chart whose query references the targeted dimension.
Charts respect the [controls][ref-controls] placed on the same dashboard — filters, time granularity switchers and field switchers. A single control can drive multiple charts at once: its value is applied to every chart whose query references the targeted dimension.

If some controls are incompatible with a chart's query, the chart skips them and shows a warning icon. See [Incompatible controls][ref-incompatible-controls] for details.

## Updating charts

Charts on a published dashboard reflect the most recent published version of the workbook. To change the query, switch the chart type, or restyle the visualization, edit the underlying report in the workbook and publish a new version of the dashboard.

**Edit in Workbook** in the chart's settings menu opens that report directly, on its own workbook tab.

### Filters carried into the workbook

The dashboard's [filters][ref-controls] come along, so the report opens showing the same slice of data the chart was showing rather than re-running over everything.

They sit in the report's filter bar next to its own filters, tinted violet to set them apart, and read the same way — member, operator, value. Hovering one says **From dashboard**. What is different is that they are not the report's:

- they apply to the results on screen, and are **not** saved to the report. Publishing the workbook again will not pin them onto the chart for everyone.
- their values cannot be changed in the workbook. To explore a different value, add your own filter on the same field, or change the dashboard's control and reopen the chart.
- they can be dropped, but not kept: **Clear filter** on the chip removes it for the rest of the session and the report re-runs without it. Reopening the chart from the dashboard brings the current values back.

To change what a viewer of the dashboard can filter by, edit the [filter control][ref-controls] there — not the report.

When the report already filters the same field, both filters apply — exactly as they do on the dashboard, so the numbers match the chart you came from. A carried filter that says precisely what the report already says is left out rather than shown twice.

Only filters are carried. A [time granularity switcher or field switcher][ref-controls] on the dashboard does not follow into the workbook, so a report opened this way shows its own granularity and its own fields.

## Title

Each chart shows the name of the underlying workbook tab as its title. To rename it, open the tab in the workbook, rename the tab, and republish the dashboard — the new name flows through to every chart backed by that tab.
Expand Down
Loading
Loading