v1

latestOpenAPI 3.0.0MIT2026-07-264001,540832.7 KB

Projects

Compile query

Compile a metric query for an explore

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

exploreIdstring required

projectUuidstring required

pivotDimensionsFieldId[]

Dimension field IDs used as pivot columns (from chart's pivotConfig.columns). Used by row_total() to determine non-pivot dimensions for GROUP BY.

timezonestring

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

dimensionOverridesDimensionOverrides

metricOverridesMetricOverrides

limitnumber double required

Maximum number of rows to return

metricsFieldId[] required

List of metric field IDs to include

dimensionsFieldId[] required

List of dimension field IDs to include

exploreNamestring required

The name of the explore to query

usePreAggregateCacheboolean

parametersParametersValuesMap

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

Success

status'ok' required