Exploring

Run underlying data query

Deprecated — use the v2 Execute underlying data endpoint instead.

This endpoint was deprecated on 20 March 2025 and is past its sunset date (30 April 2025) — it may be removed at any time. Migrate to the v2 async query flow: Execute underlying data, then Get results.

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

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/runUnderlyingDataQuery/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectUuidstring required

The uuid of the project

exploreIdstring required

table name

Request body

dimensionOverridesDimensionOverrides

metricOverridesMetricOverrides

pivotDimensionsFieldId[]

timezonestring

csvLimitnumber double

limitnumber double required

metricsFieldId[] required

dimensionsFieldId[] required

exploreNamestring required

Response

Success

status'ok' required

Changes

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