Funnel Endpoints

The Funnels API lets you retrieve funnel definitions and conversion data. Use these endpoints to analyze multi-step conversion flows and identify where visitors drop off in your signup, purchase, or onboarding processes.

Endpoints

GET /api/v1/funnels

Returns a list of all funnels configured for your website, including the steps that make up each funnel. Only the site_id parameter is required.

Parameter	Type	Required	Description
`site_id`	string	Yes	Your website ID (e.g., `ds_abc123`)

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://datasaas.co/api/v1/funnels?site_id=ds_abc123"

{
  "results": [
    {
      "id": "fnl_a1b2c3",
      "name": "Signup Flow",
      "created_at": "2026-02-15T10:00:00Z",
      "funnel_steps": [
        { "name": "Landing Page", "step_type": "pageview", "step_order": 1 },
        { "name": "Pricing Page", "step_type": "pageview", "step_order": 2 },
        { "name": "Signup", "step_type": "goal", "step_order": 3 }
      ]
    },
    {
      "id": "fnl_d4e5f6",
      "name": "Purchase Flow",
      "created_at": "2026-03-01T08:30:00Z",
      "funnel_steps": [
        { "name": "Product Page", "step_type": "pageview", "step_order": 1 },
        { "name": "Add to Cart", "step_type": "goal", "step_order": 2 },
        { "name": "Checkout", "step_type": "pageview", "step_order": 3 },
        { "name": "Purchase", "step_type": "goal", "step_order": 4 }
      ]
    }
  ],
  "meta": {
    "site_id": "ds_abc123",
    "total": 2
  }
}

GET /api/v1/funnels/:id

Returns conversion data for a specific funnel within the given date range. Each step includes the number of visitors who reached it, the drop-off count, conversion rate from the previous step, and conversion rate from the first step. The :id parameter is the funnel ID.

Parameter	Type	Required	Description
`site_id`	string	Yes	Your website ID
`:id`	string	Yes	Funnel ID (URL path parameter)
`start`	string	Yes	ISO 8601 start date
`end`	string	Yes	ISO 8601 end date
`timezone`	string	No	IANA timezone. Default: UTC

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://datasaas.co/api/v1/funnels/fnl_a1b2c3?site_id=ds_abc123&start=2026-03-01&end=2026-03-26"

{
  "results": {
    "steps": [
      {
        "step_order": 1,
        "name": "Landing Page",
        "visitors": 5000,
        "drop_off": 2200,
        "conversion_from_prev": 1.0,
        "conversion_from_start": 1.0
      },
      {
        "step_order": 2,
        "name": "Pricing Page",
        "visitors": 2800,
        "drop_off": 2050,
        "conversion_from_prev": 0.56,
        "conversion_from_start": 0.56
      },
      {
        "step_order": 3,
        "name": "Signup",
        "visitors": 750,
        "drop_off": 0,
        "conversion_from_prev": 0.268,
        "conversion_from_start": 0.15
      }
    ],
    "overall_conversion": 0.15
  },
  "meta": {
    "site_id": "ds_abc123",
    "funnel_id": "fnl_a1b2c3",
    "funnel_name": "Signup Flow",
    "start": "2026-03-01T00:00:00Z",
    "end": "2026-03-26T23:59:59Z"
  }
}

Tip

The overall_conversion field represents the percentage of visitors who completed all funnel steps, calculated as the final step visitors divided by the first step visitors.

Realtime

API Reference