Run funnel query

Execute a funnel analysis query and return conversion metrics

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

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "sql": "<string>",
    "steps": [
      {
        "medianTimeToConvertSeconds": 123,
        "stepConversionRate": 123,
        "conversionRate": 123,
        "totalUsers": 123,
        "stepName": "<string>",
        "stepOrder": 123,
        "breakdownValue": "<string>"
      }
    ]
  },
  "status": "ok"
}

Path Parameters

projectUuid · string · required

The project UUID

Body

application/json

The funnel query configuration

The funnel query configuration

dateRange · object · required

Option 1

Option 2

Show child attributes

steps · object[] · required

Show child attributes

eventNameFieldId · string · required

userIdFieldId · string · required

timestampFieldId · string · required

exploreName · string · required

breakdownDimensionId · string

conversionWindow · object

Show child attributes

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok