Skip to main content

Funnels

List funnels

The step sequences saved for this site.

GET/sites/{siteId}/funnels
List funnels
curl --request GET \
  --url 'https://truestat.io/api/v1/sites/{siteId}/funnels' \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "4871b75d-ca85-467c-9475-6ab6011c9abf",
      "name": "Signup flow",
      "steps": [
        {
          "kind": "view"
        },
        {
          "kind": "view",
          "match": "starts_with",
          "value": "/pricing"
        },
        {
          "kind": "goal",
          "value": "signup"
        }
      ],
      "created_at": "2026-09-16T19:34:51.040Z",
      "updated_at": "2026-09-16T19:34:51.040Z",
      "window_seconds": 604800
    }
  ],
  "meta": {
    "page": {
      "limit": 100,
      "offset": 0,
      "has_more": false
    },
    "site_id": "6fed8980-a119-4a9c-a4d4-53e448ef9f9e"
  }
}

See Funnels for what window_seconds actually means, the three step kinds, and why editing a funnel changes its past figures.

Authorizations

Authorizationstringheaderrequired

An API key from Settings → API keys. Scopes available: analytics:read, sites:read, sites:write, settings:read, settings:write, goals:read, goals:write, funnels:read, funnels:write, notes:read, notes:write, alerts:read, alerts:write, team:read, team:write, revenue:read, revenue:write.

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

siteIdstring (uuid)pathrequired
The site's id, from `GET /sites`. A site that is not yours and a site that does not exist both answer 403, so this cannot be used to discover other people's ids.

Query parameters

limitintegerquerydefault: 100
Rows per page, 1 to 1000.
offsetintegerquerydefault: 0
Rows to skip.

Response

application/json

The answer.

dataunknown
See the example.
metaobject