Projects

Check pre-aggregate

Check pre-aggregate availability for a metric query

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

Request

Base URL
/ (relative, and the document’s source URL is not known)
Auth
none required
TypeScript
https://skmtc.dev/lightdash/apis/lightdash-api/docs/api/v1/projects/:projectUuid/explores/:exploreId/preAggregateCheck/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Success

status'ok' required

No recorded changes to this operation across all 1 revision of this API.