Catalog
getMetadata
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
Catalog
getMetadata
Get catalog metadata for tables
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
dataCatalog
/
{table}
/
metadata
{
"results": {
"fieldType": "metric",
"tableLabel": "<string>",
"joinedTables": [
"<string>"
],
"fields": [
{
"name": "<string>",
"label": "<string>",
"fieldType": "metric",
"tableLabel": "<string>",
"description": "<string>",
"requiredAttributes": {},
"icon": {
"unicode": "<string>"
},
"chartUsage": 123,
"categories": [
{
"name": "<string>",
"color": "<string>",
"tagUuid": "<string>"
}
],
"tags": [
"<string>"
],
"tableGroupLabel": "<string>",
"tableName": "<string>",
"basicType": "<string>",
"type": "field",
"catalogSearchUuid": "<string>"
}
],
"source": "<string>",
"modelName": "<string>",
"label": "<string>",
"description": "<string>",
"name": "<string>"
},
"status": "ok"
}
Response
200
application/json
Success
From T, pick a set of properties whose keys are in the union K
Available options:
metric
, dimension
Available options:
field
Construct a type with a set of properties K of type T
Available options:
metric
, dimension
Available options:
ok
{
"results": {
"fieldType": "metric",
"tableLabel": "<string>",
"joinedTables": [
"<string>"
],
"fields": [
{
"name": "<string>",
"label": "<string>",
"fieldType": "metric",
"tableLabel": "<string>",
"description": "<string>",
"requiredAttributes": {},
"icon": {
"unicode": "<string>"
},
"chartUsage": 123,
"categories": [
{
"name": "<string>",
"color": "<string>",
"tagUuid": "<string>"
}
],
"tags": [
"<string>"
],
"tableGroupLabel": "<string>",
"tableName": "<string>",
"basicType": "<string>",
"type": "field",
"catalogSearchUuid": "<string>"
}
],
"source": "<string>",
"modelName": "<string>",
"label": "<string>",
"description": "<string>",
"name": "<string>"
},
"status": "ok"
}