Spaces
CreateSpaceInProject
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
Spaces
CreateSpaceInProject
Get details for a space in a project
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
spaces
/
{spaceUuid}
{
"results": {
"slug": "<string>",
"pinnedListOrder": 123,
"pinnedListUuid": "<string>",
"groupsAccess": [
{
"spaceRole": "viewer",
"groupName": "<string>",
"groupUuid": "<string>"
}
],
"access": [
{
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer",
"hasDirectAccess": true,
"role": "viewer",
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
],
"dashboards": [
{
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceUuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"views": 123,
"firstViewedAt": "2023-11-07T05:31:56Z",
"pinnedListOrder": 123,
"validationErrors": [
{
"validationId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"error": "<string>"
}
]
}
],
"projectUuid": "<string>",
"queries": [
{
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceName": "<string>",
"spaceUuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"dashboardUuid": "<string>",
"dashboardName": "<string>",
"slug": "<string>",
"source": "dbt_explore",
"chartKind": "line",
"chartType": "cartesian",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"pinnedListOrder": 123,
"firstViewedAt": "2023-11-07T05:31:56Z",
"views": 123,
"validationErrors": [
{
"validationId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"error": "<string>"
}
]
}
],
"isPrivate": true,
"name": "<string>",
"uuid": "<string>",
"organizationUuid": "<string>"
},
"status": "ok"
}
Path Parameters
The uuid of the space's parent project
The uuid of the space to get
Response
200
application/json
Success
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
From T, pick a set of properties whose keys are in the union K
From T, pick a set of properties whose keys are in the union K
Available options:
dbt_explore
, sql
, semantic_layer
Available options:
line
, horizontal_bar
, vertical_bar
, scatter
, area
, mixed
, pie
, table
, big_number
, funnel
, custom
Available options:
cartesian
, table
, big_number
, pie
, funnel
, custom
Available options:
ok
{
"results": {
"slug": "<string>",
"pinnedListOrder": 123,
"pinnedListUuid": "<string>",
"groupsAccess": [
{
"spaceRole": "viewer",
"groupName": "<string>",
"groupUuid": "<string>"
}
],
"access": [
{
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer",
"hasDirectAccess": true,
"role": "viewer",
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
],
"dashboards": [
{
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceUuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"views": 123,
"firstViewedAt": "2023-11-07T05:31:56Z",
"pinnedListOrder": 123,
"validationErrors": [
{
"validationId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"error": "<string>"
}
]
}
],
"projectUuid": "<string>",
"queries": [
{
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceName": "<string>",
"spaceUuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"dashboardUuid": "<string>",
"dashboardName": "<string>",
"slug": "<string>",
"source": "dbt_explore",
"chartKind": "line",
"chartType": "cartesian",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"pinnedListOrder": 123,
"firstViewedAt": "2023-11-07T05:31:56Z",
"views": 123,
"validationErrors": [
{
"validationId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"error": "<string>"
}
]
}
],
"isPrivate": true,
"name": "<string>",
"uuid": "<string>",
"organizationUuid": "<string>"
},
"status": "ok"
}