Projects
createDashboard
API
My Account
- Overview
- GETGetAuthenticatedUser
- POSTRegisterUser
- PUTCreateEmailOneTimePasscode
- GETGetEmailVerificationStatus
- GETListMyAvailableOrganizations
- POSTJoinOrganization
- DELDeleteMe
- GETcreateWarehouseCredentials
- POSTupdateWarehouseCredentials
- DELdeleteWarehouseCredentials
- PATCHupdateWarehouseCredentials
- GETgetLoginOptions
- PATCHRotate personal access token
Organizations
- Overview
- GETGetMyOrganization
- PUTCreateOrganization
- PATCHUpdateMyOrganization
- DELDeleteMyOrganization
- GETListOrganizationProjects
- GETListOrganizationMembers
- GETGetOrganizationMemberByUuid
- DELDeleteOrganizationMember
- GETListOrganizationEmailDomains
- PATCHUpdateOrganizationEmailDomains
- GETListGroupsInOrganization
- POSTCreateGroupInOrganization
Projects
- Overview
- GETGetExplores
- PUTSetExplores
- GETGetExplore
- POSTCompileQuery
- POSTDownloadCsvFromExplore
- GETGetProject
- GETListChartsInProject
- GETListChartSummariesInProject `Deprecated`
- GETListSpacesInProject
- GETGetProjectAccessList
- POSTCalculateTotalFromQuery
- GETgetUserWarehouseCredentialsPreference
- PATCHupdateUserWarehouseCredentialsPreference
- GETgetCustomMetrics
- PATCHupdateProjectMetadata
- DELdeleteProjectSemanticLayerConnection
- PATCHupdateProjectSemanticLayerConnection
- GETgetDashboards
- POSTcreateDashboard
- PATCHupdateDashboards
- POSTcreatePreview
- PATCHPatch apiv1projects schedulersettings
- GETgetTags
- POSTcreateTag
- DELdeleteTag
- PATCHupdateTag
- GETgetChartsAsCode
- GETgetDashboardsAsCode
- POSTupsertChartAsCode
- POSTupsertDashboardAsCode
- GETGetLatestValidationResults
- POSTValidateProject
- DELDeleteValidationDismiss
Roles & Permissions
- PATCHUpdateOrganizationMember
- POSTCreateSpaceInProject
- GETGet apiv1projects access
- POSTGetProjectAccessList
- GETGetProjectMemberAccess
- DELRevokeProjectAccessForUser
- PATCHGrantProjectAccessToUser
- PATCHUpdateSpace
- POSTAddSpaceUserAccess
- DELRevokeSpaceAccessForUser
- POSTAddSpaceGroupAccess
- DELRevokeGroupSpaceAccess
Catalog
- GETgetCatalog
- GETgetMetadata
- GETgetAnalytics
- GETgetAnalyticsField
- GETgetMetricsCatalog
- GETgetMetric
- GETgetMetricsWithTimeDimensions
- GETgetSegmentDimensions
- POSTaddCategoryToCatalogItem
- DELremoveCategoryFromCatalogItem
- PATCHupdateCatalogItemIcon
- GETgetMetricsTree
- POSTcreateMetricsTreeEdge
- DELdeleteMetricsTreeEdge
Exports
Git Integration
User Groups
Metrics Explorer
Notifications
Charts
Schedulers
Share links
SSH Keypairs
Projects
createDashboard
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
dashboards
{
"results": {
"config": {
"isDateZoomDisabled": true
},
"slug": "<string>",
"access": [
{
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer",
"hasDirectAccess": true,
"role": "viewer",
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
],
"isPrivate": true,
"tabs": [
{
"order": 123,
"name": "<string>",
"uuid": "<string>"
}
],
"pinnedListOrder": 123,
"pinnedListUuid": "<string>",
"firstViewedAt": "2023-11-07T05:31:56Z",
"views": 123,
"spaceName": "<string>",
"spaceUuid": "<string>",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"filters": {
"tableCalculations": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
],
"metrics": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
],
"dimensions": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
]
},
"tiles": [
{
"uuid": "<string>",
"type": "saved_chart",
"x": 123,
"y": 123,
"h": 123,
"w": 123,
"tabUuid": "<string>",
"properties": {
"chartSlug": "<string>",
"lastVersionChartKind": "line",
"chartName": "<string>",
"belongsToDashboard": true,
"savedChartUuid": "<string>",
"hideTitle": true,
"title": "<string>"
}
}
],
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"name": "<string>",
"uuid": "<string>",
"dashboardVersionId": 123,
"projectUuid": "<string>",
"organizationUuid": "<string>"
},
"status": "ok"
}
Path Parameters
Query Parameters
Response
201
application/json
Created
Available options:
viewer
, editor
, admin
Available options:
organization
, project
, group
, space_group
Available options:
member
, viewer
, interactive_viewer
, editor
, developer
, admin
Available options:
viewer
, interactive_viewer
, editor
, developer
, admin
Available options:
isNull
, notNull
, equals
, notEquals
, startsWith
, endsWith
, include
, doesNotInclude
, lessThan
, lessThanOrEqual
, greaterThan
, greaterThanOrEqual
, inThePast
, notInThePast
, inTheNext
, inTheCurrent
, notInTheCurrent
, inBetween
Construct a type with a set of properties K of type T
Available options:
isNull
, notNull
, equals
, notEquals
, startsWith
, endsWith
, include
, doesNotInclude
, lessThan
, lessThanOrEqual
, greaterThan
, greaterThanOrEqual
, inThePast
, notInThePast
, inTheNext
, inTheCurrent
, notInTheCurrent
, inBetween
Construct a type with a set of properties K of type T
Available options:
isNull
, notNull
, equals
, notEquals
, startsWith
, endsWith
, include
, doesNotInclude
, lessThan
, lessThanOrEqual
, greaterThan
, greaterThanOrEqual
, inThePast
, notInThePast
, inTheNext
, inTheCurrent
, notInTheCurrent
, inBetween
Construct a type with a set of properties K of type T
Make all properties in T required
Available options:
saved_chart
Available options:
line
, horizontal_bar
, vertical_bar
, scatter
, area
, mixed
, pie
, table
, big_number
, funnel
, custom
Available options:
ok
{
"results": {
"config": {
"isDateZoomDisabled": true
},
"slug": "<string>",
"access": [
{
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer",
"hasDirectAccess": true,
"role": "viewer",
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
],
"isPrivate": true,
"tabs": [
{
"order": 123,
"name": "<string>",
"uuid": "<string>"
}
],
"pinnedListOrder": 123,
"pinnedListUuid": "<string>",
"firstViewedAt": "2023-11-07T05:31:56Z",
"views": 123,
"spaceName": "<string>",
"spaceUuid": "<string>",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"filters": {
"tableCalculations": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
],
"metrics": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
],
"dimensions": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
]
},
"tiles": [
{
"uuid": "<string>",
"type": "saved_chart",
"x": 123,
"y": 123,
"h": 123,
"w": 123,
"tabUuid": "<string>",
"properties": {
"chartSlug": "<string>",
"lastVersionChartKind": "line",
"chartName": "<string>",
"belongsToDashboard": true,
"savedChartUuid": "<string>",
"hideTitle": true,
"title": "<string>"
}
}
],
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"name": "<string>",
"uuid": "<string>",
"dashboardVersionId": 123,
"projectUuid": "<string>",
"organizationUuid": "<string>"
},
"status": "ok"
}