Funnels

Create a website funnel

POST/api/websites/{websiteId}/funnels

Saves a named funnel for the website with an optional description, its ordered steps, and the conversion window.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.

Request body

Name	Type	Description
description	string	Description of the resource.
namerequired	string	Display name of the resource.
parametersrequired	object	Configuration parameters for the resource.

Example request

{
  "description": "string",
  "name": "string",
  "parameters": {
    "steps": [
      {
        "filters": [
          {
            "operator": "eq",
            "property": "string",
            "value": "string"
          }
        ],
        "type": "path",
        "value": "string"
      }
    ],
    "window": 0
  }
}

Responses

200The operation completed successfully.

Name	Type	Description
okrequired	any	Whether the operation succeeded.

200 example

{
  "ok": {}
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

404Not found.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/websites/{websiteId}/funnels' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "string",
  "name": "string",
  "parameters": {
    "steps": [
      {
        "filters": [
          {
            "operator": "eq",
            "property": "string",
            "value": "string"
          }
        ],
        "type": "path",
        "value": "string"
      }
    ],
    "window": 0
  }
}'

PreviousGet website funnels NextGet website funnel