---
title: "Run funnel query"
method: POST
path: "/api/v1/projects/{projectUuid}/funnel/query"
tags: ["Funnel"]
---

# Run funnel query

`POST /api/v1/projects/{projectUuid}/funnel/query`

Execute a funnel analysis query and return conversion metrics

## Path parameters

- `projectUuid` string, required

## Request body

- FunnelQueryRequest
  - `breakdownDimensionId` string
  - `conversionWindow` object
    - `unit` 'hours' | 'days' | 'weeks', required
    - `value` number, double, required
  - `dateRange` union, required
    - object
      - `preset` 'last_7_days' | 'last_14_days' | 'last_30_days' | 'last_90_days' | 'last_6_months' | 'last_12_months', required — Exclude from T those types that are assignable to U
      - `type` 'preset', required
    - object
      - `end` string, required
      - `start` string, required
      - `type` 'custom', required
  - `steps` FunnelStep[], required
    - `eventName` string, required
    - `stepOrder` number, double, required
  - `eventNameFieldId` string, required
  - `userIdFieldId` string, required
  - `timestampFieldId` string, required
  - `exploreName` string, required

## Response `200`

Success

- ApiFunnelQueryResponse
  - `results` FunnelQueryResult, required
    - `sql` string, required
    - `steps` FunnelStepResult[], required
      - `breakdownValue` string
      - `medianTimeToConvertSeconds` number, double, nullable, required
      - `stepConversionRate` number, double, required
      - `conversionRate` number, double, required
      - `totalUsers` number, double, required
      - `stepName` string, required
      - `stepOrder` number, double, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/revisions/40c933755c9a/schema)