Run underlying data query

Run a query for underlying data results

POST /api/v1/projects/{projectUuid}/explores/{exploreId}/runUnderlyingDataQuery

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "rows": [
      "<unknown>"
    ],
    "cacheMetadata": {
      "cacheHit": true,
      "preAggregate": {
        "hit": true,
        "reason": {},
        "name": "<string>"
      },
      "cacheKey": "<string>",
      "cacheExpiresAt": "2023-11-07T05:31:56Z",
      "cacheUpdatedTime": "2023-11-07T05:31:56Z"
    },
    "metricQuery": {
      "tableCalculations": [
        {
          "displayName": "<string>",
          "name": "<string>",
          "sql": "<string>",
          "format": {
            "round": 123,
            "currency": "<string>",
            "prefix": "<string>",
            "suffix": "<string>",
            "custom": "<string>"
          },
          "index": 123
        }
      ],
      "limit": 123,
      "sorts": [
        {
          "descending": true,
          "fieldId": "<string>",
          "nullsFirst": true
        }
      ],
      "filters": {
        "tableCalculations": {
          "or": [
            "<unknown>"
          ],
          "id": "<string>"
        },
        "metrics": {
          "or": [
            "<unknown>"
          ],
          "id": "<string>"
        },
        "dimensions": {
          "or": [
            "<unknown>"
          ],
          "id": "<string>"
        }
      },
      "metrics": [
        "<string>"
      ],
      "dimensions": [
        "<string>"
      ],
      "exploreName": "<string>",
      "metadata": {
        "hasADateDimension": {
          "name": "<string>",
          "label": "<string>",
          "table": "<string>"
        }
      },
      "customDimensions": [
        {
          "id": "<string>",
          "name": "<string>",
          "table": "<string>",
          "dimensionId": "<string>",
          "binNumber": 123
        }
      ],
      "additionalMetrics": [
        {
          "sql": "<string>",
          "table": "<string>",
          "name": "<string>",
          "label": "<string>",
          "description": "<string>",
          "hidden": true,
          "round": 123,
          "index": 123,
          "filters": [
            {
              "id": "<string>",
              "target": {
                "fieldRef": "<string>"
              },
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true,
              "caseSensitive": true
            }
          ],
          "baseDimensionName": "<string>",
          "uuid": "<string>",
          "percentile": 123,
          "distinctKeys": [
            "<string>"
          ],
          "formatOptions": {
            "round": 123,
            "currency": "<string>",
            "prefix": "<string>",
            "suffix": "<string>",
            "custom": "<string>"
          },
          "baseMetricId": "<string>",
          "timeDimensionId": "<string>",
          "periodOffset": 123
        }
      ]
    },
    "fields": {}
  }
}

Path Parameters

projectUuid · string · required

The uuid of the project

exploreId · string · required

table name

Body

application/json

metricQuery for the chart to run

metricQuery for the chart to run

tableCalculations · object[] · required

Option 1

Option 2

Option 3

Show child attributes

limit · number<double> · required

sorts · object[] · required

Show child attributes

filters · object · required

Show child attributes

metrics · string[] · required

dimensions · string[] · required

exploreName · string · required

dimensionOverrides · object

Show child attributes

metricOverrides · object

Show child attributes

pivotDimensions · string[]

timezone · string

metadata · object

Show child attributes

dateZoom · object

Show child attributes

customDimensions · object[]

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

csvLimit · number<double>

additionalMetrics · object[]

Show child attributes

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok