Create funnel
/api/v1/create_funnelDefine an ORDERED route through the docs, as a list of goal names. Order is the whole point: a visit counts as reaching step N only if it hit steps 1..N in sequence, so a reader who lands on step 3 first is not counted. Two rules the validator enforces and you should follow when proposing one: start BROAD (most docs readers arrive deep from search or an AI answer, and a narrow step 1 excludes the majority of traffic before measuring anything), and end on a REAL OUTCOME (a funnel ending on a scroll measures attention, not results). window_hours bounds how long after step 1 a later step still counts; omit it to use the visit itself, which is the honest default for docs.
Price — $0.00001 per call (twice what serving it costs us), charged to the workspace balance, the same as over MCP.
Also reachable by name at POST /api/v1/tools/create_funnel.
Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
Machine name, e.g. 'evaluation'.
Goal names, in order. Between 2 and 8. Create the goals first with create_goal.
Human label. Defaults to the key.
Conversion window in hours. Clamped to what the plan retains — a window longer than your history can never complete.
curl -X POST 'https://docsbook.io/api/v1/create_funnel' \
-H 'Authorization: Bearer dbk_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{}'Responses#
| Status | Meaning |
|---|---|
200 |
The tool ran. Read ok to see whether it succeeded. |
401 |
Missing or invalid API key. |