Goals and funnels API

Goals and funnels both support the full set of methods. Reads need any role; creating, changing and deleting need owner or editor.

Goals

curl -X POST -H "Authorization: Bearer sta_your_token" \
  -H "Content-Type: application/json" \
  -d '{"name":"Signup","kind":"pageview","match":"path","pattern":"/welcome"}' \
  "https://statsy.co/api/v1/sites/ws_yoursitekey/goals"

kind is pageview, event, click, scroll or outbound. match is path (the default), wildcard or exact. pattern is the path or event name to match, and valueDefault optionally gives each conversion a value.

Breaking a goal down by property

If your goal calls carry properties, GET /sites/:site/goals/:id/breakdown?prop=plan groups conversions by one of them. prop is required. Rows come back as visitors, conversions and revenue per value, up to limit (50 by default, 500 at most).

Funnels

curl -X POST -H "Authorization: Bearer sta_your_token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Trial to paid",
    "window": "7d",
    "steps": [
      {"kind": "pageview", "pattern": "/pricing"},
      {"kind": "pageview", "pattern": "/signup"},
      {"kind": "goal", "pattern": "purchase"}
    ]
  }' \
  "https://statsy.co/api/v1/sites/ws_yoursitekey/funnels"

A funnel has between two and eight steps, each a pageview path or a goal name. window is how long a visitor has to finish: 30m, 24h, 7d or a number of seconds, anywhere from a minute to 90 days. It defaults to 7d.

The funnel report

GET /sites/:site/funnels/:id/report takes the usual range and filter parameters, plus an optional window that overrides the saved one for this run only. Each step comes back with the visitors who reached it, the drop-off from the step before, and the revenue attached.

Tip. The CLI prints the same report as a table: statsy funnels report <id> --period 30d. An AI assistant connected over MCP can read it with get_funnel.