PilotFoxDocs

Create a funnel

POST
/api/v1/sites/{siteId}/funnels

A named sequence of 2 to 10 steps (conditions), optionally to be completed within windowSeconds (90 days at most), which makes its report count users across sessions instead of single sessions.

Requires funnels:write on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: funnels:write

Path Parameters

siteId*string

Request Body

application/json
  1. body
name*string
Length1 <= length <= 100
steps*array<||>
Items2 <= items <= 10
windowSeconds?|null

Response Body

Created

application/json
  1. response
data*
Example Request
curl -X POST 'https://pilotfox.app/api/v1/sites/string/funnels' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "steps": [    {      "kind": "page",      "path": "string"    },    {      "kind": "page",      "path": "string"    }  ]}'
Example Response201
{  "data": {    "id": "string",    "name": "string",    "steps": [      {        "kind": "page",        "path": "string",        "hostname": "string",        "props": [          {            "key": "string",            "op": "eq",            "value": "string"          }        ],        "label": "string"      }    ],    "windowSeconds": 0,    "createdAt": "string",    "updatedAt": "string"  }}