/
CU
cube-js
/
Cube Platform API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 2h ago · Updated 2d ago
Details
Filter operations
App Theme
1
Dashboard Embed Access
2
Data Model
15
Data Model Uploads
4
dbt Sync
6
Deployment Creation
1
Deployments
12
Embed
5
Embed Tenants
11
Env Variables
2
Environments
4
Folders
5
GitHub
4
GitHub Connection
1
Notifications
8
OAuth Integrations
5
OIDC Token Configs
5
OpenAPI Spec
1
Regions
1
Reports
9
Tenant Settings
2
User Attribute Values
2
User Attributes
3
User OAuth Tokens
4
Users Admin
4
Workbooks
9
get
Get workbooks
post
Create workbook
put
Create or update a workbook by slug
get
Get workbook
put
Update a workbook
delete
Delete workbook
put
Update workbook dashboard
post
Clone a workbook
post
Publish dashboard
Workspace
5
Workbooks
Create workbook
post
/api/v1/deployments/{deploymentId}/workbooks
Path parameters
deploymentId
number
required
Request body
CreateWorkbookInput
required
folderId
number
nullable
meta
object
nullable
name
string
nullable
Response
Workbook
required
calculatedFields
object
required
createdAt
union
required
createdBy
integer
dashboardDraft
DashboardConfig
dashboardPublished
DashboardConfig
deploymentId
integer
required
folderId
number
nullable
folderPath
WorkspaceFolderPathEntry[]
id
integer
required
isFavorite
boolean
nullable
meta
object
required
name
string
required
publishedDashboard
Dashboard
slug
string
nullable
type
'FOLDER'
|
'WORKBOOK'
|
'REPORT'
required
updatedAt
union
required
user
ResourceOwner
userId
number
nullable
Changes