Added
POST /api/v1/deployments/{deploymentId}/dbt-syncoperation (DbtSyncPublicController.startDbtSync) — starts a dbt sync for a deployment, optionally on a specific branch. New schemas:StartDbtSyncInput(branchName),DbtSyncResponse(branchName,syncJobId,workflowId).PUT /api/v1/deployments/{deploymentId}/reports/{reportId}/connect-workbookoperation (ReportsPublicController.connectReportToWorkbook) — links a report to the caller’s own spreadsheet by recording its placement, and returns the updatedReport. Requires only read access to the report. New schema:ConnectReportToWorkbookInput(externalWorkbookId,resultLocation,endResultCell).- New
SecretsManageandDownloadDataRBAC actions, available across all policy action enums (RoleWithAccess.actions, the inherited/resource user & group policy actions, and the update-policy request bodies). AIEngineerSettingsnow includeschatThreadPolicies. New schemas:ChatThreadPolicyDTO(actions,effect,resourceType,resources),ChatThreadPolicyDTOEffect(allow|deny),ChatThreadPolicyDTOResourceType.GET /api/v1/deployments/{deploymentId}/reportsaccepts a newsearchquery filter.Reportnow includescanEdit,canManage, andexternalWorkbookPlacements— a report can be placed in multiple spreadsheets. New schema:ReportPlacement(workbookId,resultLocation,endResultCell).ReportSnapshotnow includesfillMissingRows. New schema:FillMissingRows(member,excludedDimensions).CreatorModenow includesshowGeneratedSqlandshowSemanticSqltoggles.Dashboardnow includesrestrictDataDownloadanduseBoardDashboards.UpdatePublishedAiWidgetThreadInputaccepts an optionalchecksum.
Changed
DashboardConfigInput.widgetsis now optional.
Added
POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-threadoperation (WorkbooksPublicController.updatePublishedDashboardAiWidgetThread) — attaches an AI widget thread to a published dashboard and returns the updatedDashboard. New schema:UpdatePublishedAiWidgetThreadInput(threadId,widgetId).DELETE /api/v1/embed-tenants/{embedTenantName}/operation (EmbedTenantAdminPublicController.deleteEmbedTenant) for deleting an embed tenant.CubePlatformClientConfig.credentialsoption, forwarded to the underlyingfetchto control the credentials mode. Defaults to the browser’ssame-originbehaviour; set'omit'for token-only clients (e.g. signed embedding) that must never authenticate via a cookie.- Embed session requests (
GenerateSession) accepttenantGroupsandtenantGroupDefinitions— per-embed-tenant groups for sharing and organizing content within a single embed tenant (Creator Mode), namespaced separately from the globalgroups. NewembedTenantProfilefield with adisplayName. New schema:EmbedTenantProfile. AppConfigResponsenow includes anembeddingfield. New schema:EmbedSettings(locale).CreatorModenow includeslocalizedTitlesfor per-locale workspace titles. New schema:LocalizedValue(locale,value).GET /api/v1/deployments/{deploymentId}/reportsaccepts newfolderIdandexternalWorkbookIdquery filters.UpdateWorkbookInputacceptsslugandslugTakeover, and theWorkbookresponse now includesslug.
Changed
UserAttributeDefinitionDTOTypenow includes a"boolean"value, andUserAttributeInput.valueacceptsboolean.
Removed
- BREAKING: removed the
GET /api/v1/embed-tenants/{embedTenantName}/user-attributesandDELETE /api/v1/embed-tenants/{embedTenantName}/user-attributes/{id}operations, along with theUserAttribute,UserAttributesConnectionResponse, andUserAttributeDTOTypeschemas. - BREAKING: removed the
ephemeralTtlSecondsfield from the embed session request (GenerateSession).
Added
GET /api/v1/app-configoperation (AppThemePublicController.getAppConfig) returning the deployment’s app configuration —appTheme,applyThemeGlobally, andcreatorMode. New schemas:AppConfigResponse,AppTheme,CreatorMode.- Scheduled notifications can now carry dashboard
filtersandtimeGrainsthat are applied when the dashboard is run. Available onCreateNotificationInput,UpdateNotificationInput, and theNotificationresponse. New schemas:DashboardFilter,DashboardFilterInput,DashboardFilterOperator,DashboardFilterInputOperator,DashboardTimeGrain,DashboardTimeGrainInput. CreateNotificationInputacceptsdashboardPublicId(string) as an alternative to the numericdashboardId— supply exactly one.GET /notificationsaccepts new filter query parameters:dashboardPublicId, and recipient filtersrecipientUserId/recipientEmail(console user) orrecipientEmbedTenantName+recipientExternalId(embed user).POST /workbooks/{workbookId}/duplicateaccepts an optionalDuplicateWorkbookInputbody with asharedflag to clone a workbook from the shared workspace. New schema:DuplicateWorkbookInput.Dashboardnow includes afromSharedWorkspacefield.Workbooknow includes auserfield (ResourceOwner).InheritedUserPolicyDtoandResourceUserPolicyDtonow includeemail,firstName, andpicturefields.
Changed
CreateNotificationInput.dashboardIdis now optional; identify the target dashboard with eitherdashboardIdor the newdashboardPublicId.
Added
GET /api/v1/deployments/{deploymentId}/reportsnow supports cursor-based pagination via thefirstandafterquery parameters, and returns anitemsarray alongside apageInfocursor block — matching the folders and other list endpoints. (Cursor pagination is not available when sorting bylastViewedAt.)- The reports list now accepts
nameas asortByvalue, in addition tocreatedAt,updatedAt, andlastViewedAt. NotificationRecipientnow includes an optionalusernamefield.
Changed
- BREAKING: The reports list response type
ReportsFindAllResultis nowReportsListResponse.
Deprecated
- The
dataandcountfields on the reports list response are deprecated in favor ofitemsandpageInfo. They remain populated for backward compatibility.
Added
GET /api/v1/deployments/{deploymentId}/foldersnow supports cursor-based pagination via thefirstandafterquery parameters, and returns anitemsarray alongside apageInfocursor block — matching the other list endpoints.
Changed
- BREAKING: The folders list response type
FoldersFindAllResultis nowFoldersListResponse.
Deprecated
- The
dataandcountfields on the folders list response are deprecated in favor ofitemsandpageInfo. They remain populated for backward compatibility.
Added
createCubePlatformClient— the new name for the client factory.- Cube Platform-branded type and hook names:
CubePlatformClient,CubePlatformClientConfig,PlatformApiSchemas, and the react-query exportsCubePlatformApiProvider,useCubePlatformApi,useCubePlatformApiQuery,useCubePlatformApiSuspenseQuery,useCubePlatformApiMutation,useCubePlatformApiLazyQuery,useCubePlatformApiQueryOptions,CubePlatformApiQueryKey,UseCubePlatformApiLazyQueryResult.
Deprecated
- The former
CubeCloud*/ConsoleApiSchemasnames are deprecated in favor of theCubePlatform*/PlatformApiSchemasequivalents. All remain as aliases and will be removed in a future major version:createCubeCloudApiClient,CubeCloudApiClient,CubeCloudApiClientConfig,ConsoleApiSchemas,CubeCloudApiProvider,CubeCloudApiProviderProps,useCubeCloudApi,useCubeCloudApiQuery,useCubeCloudApiSuspenseQuery,useCubeCloudApiMutation,useCubeCloudApiLazyQuery,useCubeCloudApiQueryOptions,CubeCloudApiQueryKey,UseCubeCloudApiLazyQueryResult.