Funnel

Run funnel query

Execute a funnel analysis query and return conversion metrics

post/api/v1/projects/{projectUuid}/funnel/query

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

projectUuidstring required

The project UUID

breakdownDimensionIdstring

eventNameFieldIdstring required

userIdFieldIdstring required

timestampFieldIdstring required

exploreNamestring required

Success

status'ok' required

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