Exploring
Post apiv1projects explores runquery
deprecated
Run a query for explore
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
explores
/
{exploreId}
/
runQuery
Copy
Ask AI
{
"results": {
"fields": {},
"rows": [
"<any>"
],
"cacheMetadata": {
"cacheHit": true,
"cacheKey": "<string>",
"cacheExpiresAt": "2023-11-07T05:31:56Z",
"cacheUpdatedTime": "2023-11-07T05:31:56Z"
},
"metricQuery": {
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>",
"table": "<string>"
}
},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123,
"binWidth": 123,
"customRange": [
{
"to": 123,
"from": 123
}
]
}
],
"additionalMetrics": [
{
"label": "<string>",
"type": "percentile",
"description": "<string>",
"sql": "<string>",
"hidden": true,
"round": 123,
"compact": "thousands",
"format": "km",
"table": "<string>",
"name": "<string>",
"index": 123,
"filters": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true
}
],
"baseDimensionName": "<string>",
"uuid": "<string>",
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
}
}
],
"tableCalculations": [
{
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"sql": "<string>",
"displayName": "<string>",
"name": "<string>",
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>"
}
],
"filters": {
"tableCalculations": {
"or": [
"<any>"
],
"id": "<string>"
},
"metrics": {
"or": [
"<any>"
],
"id": "<string>"
},
"dimensions": {
"or": [
"<any>"
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>"
}
},
"status": "ok"
}
Body
application/json
metricQuery for the chart to run
Response
200
application/json
Success
The response is of type object
.
Copy
Ask AI
{
"results": {
"fields": {},
"rows": [
"<any>"
],
"cacheMetadata": {
"cacheHit": true,
"cacheKey": "<string>",
"cacheExpiresAt": "2023-11-07T05:31:56Z",
"cacheUpdatedTime": "2023-11-07T05:31:56Z"
},
"metricQuery": {
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>",
"table": "<string>"
}
},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123,
"binWidth": 123,
"customRange": [
{
"to": 123,
"from": 123
}
]
}
],
"additionalMetrics": [
{
"label": "<string>",
"type": "percentile",
"description": "<string>",
"sql": "<string>",
"hidden": true,
"round": 123,
"compact": "thousands",
"format": "km",
"table": "<string>",
"name": "<string>",
"index": 123,
"filters": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true
}
],
"baseDimensionName": "<string>",
"uuid": "<string>",
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
}
}
],
"tableCalculations": [
{
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"sql": "<string>",
"displayName": "<string>",
"name": "<string>",
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>"
}
],
"filters": {
"tableCalculations": {
"or": [
"<any>"
],
"id": "<string>"
},
"metrics": {
"or": [
"<any>"
],
"id": "<string>"
},
"dimensions": {
"or": [
"<any>"
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>"
}
},
"status": "ok"
}
Assistant
Responses are generated using AI and may contain mistakes.