Skip to main content
POST
/
api
/
v1
/
analytics
/
funnels
Create funnel
curl --request POST \
  --url https://api.engagefabric.com/api/v1/analytics/funnels \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Onboarding Funnel",
  "steps": [
    {
      "name": "Sign Up",
      "eventType": "player.created",
      "filters": {
        "source": "organic"
      }
    }
  ],
  "description": "Tracks player journey from signup to first quest completion"
}
'
{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "steps": "<array>",
  "isActive": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "description": "<string>"
}

Body

application/json
projectId
string
required

Project ID for the funnel

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

Funnel name

Example:

"Onboarding Funnel"

steps
object[]
required

Funnel steps (2-10 steps)

description
string

Funnel description

Example:

"Tracks player journey from signup to first quest completion"

Response

201 - application/json

Funnel created

id
string
required

Funnel ID

projectId
string
required

Project ID

name
string
required

Funnel name

steps
array
required

Funnel steps configuration

isActive
boolean
required

Whether the funnel is active

createdAt
string
required

Created timestamp

updatedAt
string
required

Updated timestamp

description
string

Funnel description