Projects
CompileQuery
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
CompileQuery
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
explores
/
{exploreId}
/
compileQuery
{
"results": "<string>",
"status": "ok"
}Body
application/json
Available options:
number, string, date, timestamp, boolean Available options:
default, percent, currency, number, id, date, timestamp Available options:
default, commaPeriod, spacePeriod, periodComma, noSeparatorPeriod Available options:
thousands, millions, billions, trillions Available options:
RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM Available options:
bin Available options:
fixed_number, fixed_width, custom_range Available options:
percentile, average, count, count_distinct, sum, min, max, number, median, string, date, timestamp, boolean Available options:
thousands, millions, billions, trillions Available options:
km, mi, usd, gbp, eur, id, percent Available options:
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween Available options:
default, percent, currency, number, id, date, timestamp Available options:
default, commaPeriod, spacePeriod, periodComma, noSeparatorPeriod Available options:
thousands, millions, billions, trillions Available options:
RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM {
"results": "<string>",
"status": "ok"
}