Skip to main content
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
funnel
/
query
Error
A valid request URL is required to generate request examples
{
  "results": {
    "sql": "<string>",
    "totalUsersAtStep1": 123,
    "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
steps
object[]
required
eventNameFieldId
string
required
userIdFieldId
string
required
timestampFieldId
string
required
exploreName
string
required
breakdownDimensionId
string
conversionWindow
object

Response

Success

results
object
required
status
enum<string>
required
Available options:
ok