Skip to main content
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
explores
/
{exploreId}
/
runUnderlyingDataQuery
cURL
curl --request POST \
  --url http://api/v1/projects/{projectUuid}/explores/{exploreId}/runUnderlyingDataQuery \
  --header 'Content-Type: application/json' \
  --data '
{
  "metricOverrides": {},
  "timezone": "<string>",
  "metadata": {
    "hasADateDimension": {
      "name": "<string>",
      "label": "<string>",
      "table": "<string>"
    }
  },
  "dateZoom": {
    "xAxisFieldId": "<string>",
    "granularity": "Day"
  },
  "customDimensions": [
    {
      "id": "<string>",
      "name": "<string>",
      "table": "<string>",
      "type": "bin",
      "dimensionId": "<string>",
      "binType": "fixed_number",
      "binNumber": 123,
      "binWidth": 123,
      "customRange": [
        {
          "to": 123,
          "from": 123
        }
      ]
    }
  ],
  "csvLimit": 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": [
    {
      "nullsFirst": true,
      "descending": true,
      "fieldId": "<string>"
    }
  ],
  "filters": {
    "tableCalculations": "<any>",
    "metrics": "<any>",
    "dimensions": "<any>"
  },
  "metrics": [
    "<string>"
  ],
  "dimensions": [
    "<string>"
  ],
  "exploreName": "<string>"
}
'
{
  "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": "<any>"
              },
              "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": [
        {
          "nullsFirst": true,
          "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"
}

Path Parameters

​
projectUuid
string
required

The uuid of the project

​
exploreId
string
required

table name

Body

application/json

metricQuery for the chart to run

​
tableCalculations
object[]
required
​
limit
number
required
​
sorts
object[]
required
​
filters
object
required
​
metrics
string[]
required
​
dimensions
string[]
required
​
exploreName
string
required
​
metricOverrides
object
​
timezone
string
​
metadata
object
​
dateZoom
object
​
customDimensions
object[]
  • Option 1
  • Option 2
​
csvLimit
number
​
additionalMetrics
object[]

Response

Success

​
results
object
required
​
status
enum<string>
required
Available options:
ok