---
title: "List a site's configured conversion funnels"
method: GET
path: "/funnels"
tags: ["Stats"]
---

# List a site's configured conversion funnels

`GET /funnels`

## Request

- Base URL: `https://statable.com/api/v1`
- URL: `https://statable.com/api/v1/funnels`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/statable/apis/statable-stats-api/docs/funnels/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the site's saved funnel definitions (managed in the dashboard). Use a funnel `id` with POST /funnels/{id}/report. Funnels are read-only over the API — this endpoint does not create or edit them.

## Query parameters

- `site_id` integer

## Response `200`

The site's funnel definitions.

- object
  - `funnels` FunnelDefinition[], required
    - `id` integer
    - `site_id` integer
    - `name` string
    - `scope` 'visitor' | 'session'
    - `strict_order` boolean: When true, steps must occur in exact order (windowFunnel strict_order).
    - `steps` FunnelStep[]
      - `kind` 'page' | 'event' | 'goal' | 'scroll' | 'entry_page' | 'exit_page', required
      - `path` string: URL path — for kind page/entry_page/exit_page.
      - `operator` string: Path match operator (e|b|c|r) — for kind page/entry_page/exit_page. `r` is an RE2 regex; one that does not compile is refused with 400.
      - `event` string: Custom event name — for kind event.
      - `prop_key` string: Optional custom-property key — for kind event.
      - `prop_value` string: Optional custom-property value — for kind event.
      - `goal_id` integer: Goal id — for kind goal.
      - `threshold` integer: Scroll depth 0..100 — for kind scroll.
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `400`: Invalid request. Branch on the stable `code`: invalid_request, metrics_required, unknown_metric, too_many_dimensions, unknown_dimension, invalid_date_range, invalid_interval, metric_not_available, invalid_filter, event_filter_required, invalid_compare, compare_length_mismatch, site_id_required, limit_offset_misuse.
- `401`: Missing/malformed/invalid/revoked bearer token (`unauthorized`), or a key past its expiry (`key_expired`; the message names the expiry time).
- `403`: `insufficient_scope` (the key lacks the `read` scope every endpoint here requires), `key_not_scoped` (single-site key asked for a different site), `tracking_inactive` (the site's tracking has stopped) or `plan_expired` (the site owner's plan has expired: tracking may still run through the grace period, but reports are closed until the owner chooses a plan).
- `404`: `unknown_site` — the `site_id` does not exist OR the key's owner has no access. Deliberately indistinguishable (same status AND code) so a key cannot enumerate which site_ids exist. `unknown_funnel` (funnel endpoints only) — the funnel id is not found for the resolved site.
- `429`: Hourly account (default 2000/h) or per-key (default 600/h) limit hit (`rate_limited`). Retry after the `Retry-After` seconds. The X-RateLimit-* headers report the window that tripped (account on an account limit).
- `500`: Unexpected server error (`internal`). Report it with the `request_id` from the body or the X-Request-ID header: it is what lets the exact log entry be found, and without it a 500 can only be matched by guessing at a time window.

---

[API](https://skmtc.dev/statable/apis/statable-stats-api.md) - [All operations](https://skmtc.dev/statable/apis/statable-stats-api/llms.txt) - [OpenAPI document](https://skmtc.dev/statable/apis/statable-stats-api/revisions/352b6d47c186?raw)