API
Reference
- Projects
- My Account
- User attributes
- SSH Keypairs
- SQL runner
- Spotlight
- Spaces
- Roles & Permissions
- Integrations
- Share links
- Schedulers
- Exploring
- Charts
- Content
- Organizations
- Notifications
- Metrics Explorer
- User Groups
- API Reference
- Git Integration
- Dashboards
- Exports
- Comments
- Catalog
- GETGet apiv1projects datacatalog
- GETGet apiv1projects datacatalog metadata
- GETGet apiv1projects datacatalog analytics
- GETGet apiv1projects datacatalog analytics 1
- GETGet apiv1projects datacatalogmetrics
- GETGet apiv1projects datacatalogmetrics
- GETGet apiv1projects datacatalogmetrics with time dimensions
- GETGet apiv1projects datacatalog segment dimensions
- POSTPost apiv1projects datacatalog categories
- DELDelete apiv1projects datacatalog categories
- PATCHPatch apiv1projects datacatalog icon
- GETGet apiv1projects datacatalogmetricstree
- POSTPost apiv1projects datacatalogmetricstreeedges
- DELDelete apiv1projects datacatalogmetricstreeedges
- GETGet apiv1projects datacatalogmetricshas
- GET
- v2
Catalog
Get apiv1projects datacatalogmetrics
Get metric by table and metric name
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
dataCatalog
/
metrics
/
{tableName}
/
{metricName}
Copy
Ask AI
{
"results": {
"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>"
],
"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",
"custom": "<string>"
},
"dimensionReference": "<string>",
"requiredAttributes": {},
"defaultTimeDimension": {
"interval": "RAW",
"field": "<string>"
},
"spotlight": {
"categories": [
"<string>"
],
"visibility": "show"
},
"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"
}
Response
200
application/json
Success
The response is of type object
.
Copy
Ask AI
{
"results": {
"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>"
],
"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",
"custom": "<string>"
},
"dimensionReference": "<string>",
"requiredAttributes": {},
"defaultTimeDimension": {
"interval": "RAW",
"field": "<string>"
},
"spotlight": {
"categories": [
"<string>"
],
"visibility": "show"
},
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.