List Funnels

List all funnels for a site.

List Funnels

Returns all funnels defined for a site, including their steps.

Endpoint

GET /api/v1/organizations/:orgId/sites/:siteId/funnels

Response fields

Each funnel object contains:

Field	Type	Description
`id`	`string`	Funnel ID
`site_id`	`string`	Site ID
`name`	`string`	Funnel name
`description`	`string`	Funnel description
`steps`	`array`	Ordered funnel steps

Each step contains:

Field	Type	Description
`id`	`string`	Step ID
`name`	`string`	Step label
`order`	`number`	Step position (1-indexed)
`type`	`string`	`pageview` or `custom_event`
`pattern`	`string`	Page path or event name
`match_type`	`string`	`exact`, `contains`, or `regex`

Example request (cURL)

curl -X GET \
  'https://api.engagetrack.net/api/v1/organizations/{orgId}/sites/{siteId}/funnels' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json'

Success response (200 OK)

{
  "success": true,
  "data": [
    {
      "id": "funnel_abc",
      "site_id": "site_abc123",
      "name": "Signup Flow",
      "description": "Tracks users from landing to signup",
      "steps": [
        {
          "id": "step_1",
          "name": "Landing",
          "order": 1,
          "type": "pageview",
          "pattern": "/",
          "match_type": "exact"
        },
        {
          "id": "step_2",
          "name": "Signup Page",
          "order": 2,
          "type": "pageview",
          "pattern": "/signup",
          "match_type": "exact"
        }
      ],
      "created_at": "2024-02-01T10:00:00Z"
    }
  ]
}