Funnel analysis endpoint

GET /api/v1/sites/{site}/funnels

Returns funnel step-by-step conversion data. If no funnel_id is provided, returns data for the first funnel. Returns empty arrays if no funnels are configured.

Note: This endpoint does not support comparison date ranges.

Additional parameters

ParameterRequiredDescription
funnel_idNoUUID of the funnel to analyze. Defaults to the first funnel.

Example request

curl -H "Authorization: Bearer your-token" "https://pageviews.ai/api/v1/sites/{site_id}/funnels?from=2026-03-01&to=2026-03-07"

Response

  • funnels — List of available funnels with id and name
  • selectedFunnelId — UUID of the currently selected funnel
  • steps — Array of funnel steps, each with name, detail (goal type), value (conversion count), and percentage (relative to first step, 0–100)

Example response

{
  "data": {
    "funnels": [
      { "id": "a1b2c3d4-...", "name": "Signup Flow" }
    ],
    "selectedFunnelId": "a1b2c3d4-...",
    "steps": [
      { "name": "Visit Homepage", "detail": "Pageview", "value": 1000, "percentage": 100 },
      { "name": "View Pricing", "detail": "Pageview", "value": 450, "percentage": 45 },
      { "name": "Start Trial", "detail": "Custom Event", "value": 120, "percentage": 12 }
    ]
  }
}