Catalog
getSegmentDimensions
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
getSegmentDimensions
Get dimensions that can be used to segment metrics
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
dataCatalog
/
{tableName}
/
segment-dimensions
{
"results": [
{
"fieldType": "dimension",
"type": "string",
"name": "<string>",
"label": "<string>",
"table": "<string>",
"tableLabel": "<string>",
"sql": "<string>",
"description": "<string>",
"source": {
"content": "<string>",
"highlight": {
"end": {
"character": 123,
"line": 123
},
"start": {
"character": 123,
"line": 123
}
},
"range": {
"end": {
"character": 123,
"line": 123
},
"start": {
"character": 123,
"line": 123
}
},
"path": "<string>"
},
"hidden": true,
"compact": "thousands",
"round": 123,
"format": "km",
"groupLabel": "<string>",
"groups": [
"<string>"
],
"urls": [
{
"label": "<string>",
"url": "<string>"
}
],
"index": 123,
"tags": [
"<string>"
],
"group": "<string>",
"requiredAttributes": {},
"timeInterval": "RAW",
"timeIntervalBaseDimensionName": "<string>",
"isAdditionalDimension": true,
"colors": {},
"isIntervalBase": true,
"compiledSql": "<string>",
"tablesReferences": [
"<string>"
],
"tablesRequiredAttributes": {}
}
],
"status": "ok"
}
Response
200
application/json
Success
The response is of type object
.
{
"results": [
{
"fieldType": "dimension",
"type": "string",
"name": "<string>",
"label": "<string>",
"table": "<string>",
"tableLabel": "<string>",
"sql": "<string>",
"description": "<string>",
"source": {
"content": "<string>",
"highlight": {
"end": {
"character": 123,
"line": 123
},
"start": {
"character": 123,
"line": 123
}
},
"range": {
"end": {
"character": 123,
"line": 123
},
"start": {
"character": 123,
"line": 123
}
},
"path": "<string>"
},
"hidden": true,
"compact": "thousands",
"round": 123,
"format": "km",
"groupLabel": "<string>",
"groups": [
"<string>"
],
"urls": [
{
"label": "<string>",
"url": "<string>"
}
],
"index": 123,
"tags": [
"<string>"
],
"group": "<string>",
"requiredAttributes": {},
"timeInterval": "RAW",
"timeIntervalBaseDimensionName": "<string>",
"isAdditionalDimension": true,
"colors": {},
"isIntervalBase": true,
"compiledSql": "<string>",
"tablesReferences": [
"<string>"
],
"tablesRequiredAttributes": {}
}
],
"status": "ok"
}