Projects
GetProject
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
GetProject
Get a project of an organiztion
GET
/
api
/
v1
/
projects
/
{projectUuid}
{
"results": {
"createdByUserUuid": "<string>",
"schedulerTimezone": "<string>",
"semanticLayerConnection": {
"token": "<string>",
"domain": "<string>",
"environmentId": "<string>",
"type": "DBT"
},
"dbtVersion": "v1.4",
"upstreamProjectUuid": "<string>",
"pinnedListUuid": "<string>",
"warehouseConnection": {
"type": "snowflake",
"warehouse": "<string>",
"role": "<string>",
"account": "<string>",
"requireUserCredentials": true,
"database": "<string>",
"schema": "<string>",
"threads": 123,
"clientSessionKeepAlive": true,
"queryTag": "<string>",
"accessUrl": "<string>",
"startOfWeek": 0,
"quotedIdentifiersIgnoreCase": true,
"override": "<string>"
},
"dbtConnection": {
"type": "dbt",
"target": "<string>",
"environment": [
{
"value": "<string>",
"key": "<string>"
}
],
"profiles_dir": "<string>",
"project_dir": "<string>"
},
"type": "DEFAULT",
"name": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>"
},
"status": "ok"
}
Path Parameters
Response
200
application/json
Success
Available options:
v1.4
, v1.5
, v1.6
, v1.7
, v1.8
Available options:
dbt
Available options:
DEFAULT
, PREVIEW
From T, pick a set of properties whose keys are in the union K
Available options:
snowflake
Available options:
0
, 1
, 2
, 3
, 4
, 5
, 6
Available options:
ok
{
"results": {
"createdByUserUuid": "<string>",
"schedulerTimezone": "<string>",
"semanticLayerConnection": {
"token": "<string>",
"domain": "<string>",
"environmentId": "<string>",
"type": "DBT"
},
"dbtVersion": "v1.4",
"upstreamProjectUuid": "<string>",
"pinnedListUuid": "<string>",
"warehouseConnection": {
"type": "snowflake",
"warehouse": "<string>",
"role": "<string>",
"account": "<string>",
"requireUserCredentials": true,
"database": "<string>",
"schema": "<string>",
"threads": 123,
"clientSessionKeepAlive": true,
"queryTag": "<string>",
"accessUrl": "<string>",
"startOfWeek": 0,
"quotedIdentifiersIgnoreCase": true,
"override": "<string>"
},
"dbtConnection": {
"type": "dbt",
"target": "<string>",
"environment": [
{
"value": "<string>",
"key": "<string>"
}
],
"profiles_dir": "<string>",
"project_dir": "<string>"
},
"type": "DEFAULT",
"name": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>"
},
"status": "ok"
}