Compile query

Compile a metric query for an explore

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

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "parameterReferences": [
      "<string>"
    ],
    "query": "<string>",
    "compilationErrors": [
      "<string>"
    ],
    "pivotQuery": "<string>"
  },
  "status": "ok"
}

Path Parameters

exploreId · string · required

projectUuid · string · required

Body

application/json

tableCalculations · object[] · required

Custom calculations to perform on query results

Option 1

Option 2

Show child attributes

limit · number<double> · required

Maximum number of rows to return

sorts · object[] · required

Sort configuration for query results

Show child attributes

filters · object · required

Filter rules to apply to the query

Show child attributes

metrics · string[] · required

List of metric field IDs to include

dimensions · string[] · required

List of dimension field IDs to include

exploreName · string · required

The name of the explore to query

metadata · object

Show child attributes

timezone · string

Timezone for date/time values (e.g., 'America/Los_Angeles', 'UTC')

dimensionOverrides · object

Override formatting options for existing dimensions

Show child attributes

metricOverrides · object

Override formatting options for existing metrics

Show child attributes

customDimensions · object[]

Custom dimensions defined inline

Option 1

Option 2

Show child attributes

additionalMetrics · object[]

Custom metrics defined inline (ad-hoc metrics not in the dbt model)

Show child attributes

pivotConfiguration · object

Show child attributes

parameters · object

Construct a type with a set of properties K of type T

Show child attributes

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok