Metrics Explorer
runMetricExplorerQuery
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
Metrics Explorer
runMetricExplorerQuery
Run a metrics explorer query
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
metricsExplorer
/
{explore}
/
{metric}
/
runMetricExplorerQuery
{
"results": {
"results": [
{
"compareMetric": {
"label": "<string>",
"value": 123
},
"metric": {
"label": "<string>",
"value": 123
},
"segment": "<string>",
"date": "2023-11-07T05:31:56Z",
"dateValue": 123
}
],
"fields": {},
"segmentDimension": {
"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
},
"compareMetric": {
"fieldType": "metric",
"type": "percentile",
"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>"
],
"isAutoGenerated": true,
"showUnderlyingValues": [
"<string>"
],
"filters": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true
}
],
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW"
},
"dimensionReference": "<string>",
"requiredAttributes": {},
"defaultTimeDimension": {
"interval": "RAW",
"field": "<string>"
},
"compiledSql": "<string>",
"tablesReferences": [
"<string>"
],
"tablesRequiredAttributes": {},
"availableTimeDimensions": [
{
"fieldType": "dimension",
"type": "date",
"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": {}
}
],
"timeDimension": {
"interval": "RAW",
"field": "<string>",
"table": "<string>"
}
},
"metric": {
"fieldType": "metric",
"type": "percentile",
"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>"
],
"isAutoGenerated": true,
"showUnderlyingValues": [
"<string>"
],
"filters": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true
}
],
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW"
},
"dimensionReference": "<string>",
"requiredAttributes": {},
"defaultTimeDimension": {
"interval": "RAW",
"field": "<string>"
},
"compiledSql": "<string>",
"tablesReferences": [
"<string>"
],
"tablesRequiredAttributes": {},
"availableTimeDimensions": [
{
"fieldType": "dimension",
"type": "date",
"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": {}
}
],
"timeDimension": {
"interval": "RAW",
"field": "<string>",
"table": "<string>"
}
}
},
"status": "ok"
}Path Parameters
The project UUID
The explore name
The metric name
Body
application/json
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 Response
200
application/json
Success
Construct a type with a set of properties K of type T
Available options:
dimension Available options:
string, number, timestamp, date, boolean Available options:
thousands, millions, billions, trillions Available options:
km, mi, usd, gbp, eur, id, percent Construct a type with a set of properties K of type T
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 Construct a type with a set of properties K of type T
Available options:
metric 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 Construct a type with a set of properties K of type T
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 Construct a type with a set of properties K of type T
Available options:
dimension Available options:
date Available options:
thousands, millions, billions, trillions Available options:
km, mi, usd, gbp, eur, id, percent Construct a type with a set of properties K of type T
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 Construct a type with a set of properties K of type T
Construct a type with a set of properties K of type T
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:
metric 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 Construct a type with a set of properties K of type T
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 Construct a type with a set of properties K of type T
Available options:
dimension Available options:
date Available options:
thousands, millions, billions, trillions Available options:
km, mi, usd, gbp, eur, id, percent Construct a type with a set of properties K of type T
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 Construct a type with a set of properties K of type T
Construct a type with a set of properties K of type T
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:
ok {
"results": {
"results": [
{
"compareMetric": {
"label": "<string>",
"value": 123
},
"metric": {
"label": "<string>",
"value": 123
},
"segment": "<string>",
"date": "2023-11-07T05:31:56Z",
"dateValue": 123
}
],
"fields": {},
"segmentDimension": {
"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
},
"compareMetric": {
"fieldType": "metric",
"type": "percentile",
"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>"
],
"isAutoGenerated": true,
"showUnderlyingValues": [
"<string>"
],
"filters": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true
}
],
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW"
},
"dimensionReference": "<string>",
"requiredAttributes": {},
"defaultTimeDimension": {
"interval": "RAW",
"field": "<string>"
},
"compiledSql": "<string>",
"tablesReferences": [
"<string>"
],
"tablesRequiredAttributes": {},
"availableTimeDimensions": [
{
"fieldType": "dimension",
"type": "date",
"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": {}
}
],
"timeDimension": {
"interval": "RAW",
"field": "<string>",
"table": "<string>"
}
},
"metric": {
"fieldType": "metric",
"type": "percentile",
"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>"
],
"isAutoGenerated": true,
"showUnderlyingValues": [
"<string>"
],
"filters": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true
}
],
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW"
},
"dimensionReference": "<string>",
"requiredAttributes": {},
"defaultTimeDimension": {
"interval": "RAW",
"field": "<string>"
},
"compiledSql": "<string>",
"tablesReferences": [
"<string>"
],
"tablesRequiredAttributes": {},
"availableTimeDimensions": [
{
"fieldType": "dimension",
"type": "date",
"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": {}
}
],
"timeDimension": {
"interval": "RAW",
"field": "<string>",
"table": "<string>"
}
}
},
"status": "ok"
}