Create a conversion funnel on a Clics project via REST

Create a multistep funnel.

POST/v1/projects/{project_id}/funnels

Authorization

AuthorizationBearer token (API key) · headerrequired

Path parameters

project_idstringrequired

Clics project ID.

min length 1

Request body

requiredapplication/json

env_idstring

Optional environment. Defaults to `production`. Use `development` for localhost/dev traffic.

default: "production"

Allowed:productiondevelopment

namestringrequired

Funnel display name.

min length 1

conversion_windowobjectrequired

How long a visitor has to complete the funnel after entering the first step.

Show properties

valueintegerrequired

Length of the conversion window.

min 1

unitstringrequired

Unit for the conversion window length.

Allowed:secondsminuteshoursdaysweeksmonths

stepsobject[]required

Ordered funnel steps. At least two steps are required. Each step needs a name and at least one filter.

min items 2

Show properties

Array of object

namestringrequired

Display name for this funnel step.

min length 1

filtersobject[]required

At least one filter that defines when this step is reached.

min items 1

Show properties

Array of object

filter_typestringrequired

Dimension to match: country, device, browser, os, page, event, hostname, referrer, or utm_*.

Allowed:countrydevicebrowserospageeventhostnamereferrerutm_sourceutm_mediumutm_campaignutm_termutm_content

operatorstringrequired

Match operator: is, is_not, contains, or not_contains.

Allowed:isis_notcontainsnot_contains

valuesstring[]required

Values to match against the chosen dimension.

Responses

200Created funnel.

idstringrequired

project_idstringrequired

env_idstringrequired

Allowed:productiondevelopment

namestringrequired

conversion_windowobjectrequired

Show properties

valueintegerrequired

Length of the conversion window.

min 1

unitstringrequired

Unit for the conversion window length.

Allowed:secondsminuteshoursdaysweeksmonths

stepsobject[]required

Show properties

Array of object

namestringrequired

Display name for this funnel step.

min length 1

filtersobject[]required

At least one filter that defines when this step is reached.

min items 1

Show properties

Array of object

filter_typestringrequired

Dimension to match: country, device, browser, os, page, event, hostname, referrer, or utm_*.

Allowed:countrydevicebrowserospageeventhostnamereferrerutm_sourceutm_mediumutm_campaignutm_termutm_content

operatorstringrequired

Match operator: is, is_not, contains, or not_contains.

Allowed:isis_notcontainsnot_contains

valuesstring[]required

Values to match against the chosen dimension.

created_atnumberrequired

400Invalid request.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

401Missing or invalid API key.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

403Forbidden.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

404Resource not found.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

500Unexpected error.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

Request

curl -X POST "https://api.clics.dev/v1/projects/k17abc123/funnels" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "env_id": "production",
  "name": "Checkout",
  "conversion_window": {
    "value": 7,
    "unit": "days"
  },
  "steps": [
    {
      "name": "Cart",
      "filters": [
        {
          "filter_type": "page",
          "operator": "is",
          "values": [
            "/cart"
          ]
        }
      ]
    },
    {
      "name": "Purchase",
      "filters": [
        {
          "filter_type": "page",
          "operator": "is",
          "values": [
            "/thanks"
          ]
        }
      ]
    }
  ]
}'

const response = await fetch("https://api.clics.dev/v1/projects/k17abc123/funnels", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "env_id": "production",
  "name": "Checkout",
  "conversion_window": {
    "value": 7,
    "unit": "days"
  },
  "steps": [
    {
      "name": "Cart",
      "filters": [
        {
          "filter_type": "page",
          "operator": "is",
          "values": [
            "/cart"
          ]
        }
      ]
    },
    {
      "name": "Purchase",
      "filters": [
        {
          "filter_type": "page",
          "operator": "is",
          "values": [
            "/thanks"
          ]
        }
      ]
    }
  ]
})
});

import requests

response = requests.post(
    "https://api.clics.dev/v1/projects/k17abc123/funnels",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "env_id": "production",
  "name": "Checkout",
  "conversion_window": {
    "value": 7,
    "unit": "days"
  },
  "steps": [
    {
      "name": "Cart",
      "filters": [
        {
          "filter_type": "page",
          "operator": "is",
          "values": [
            "/cart"
          ]
        }
      ]
    },
    {
      "name": "Purchase",
      "filters": [
        {
          "filter_type": "page",
          "operator": "is",
          "values": [
            "/thanks"
          ]
        }
      ]
    }
  ]
},
)

Response

{
  "id": "string",
  "project_id": "string",
  "env_id": "production",
  "name": "string",
  "conversion_window": {
    "value": 7,
    "unit": "days"
  },
  "steps": [
    {
      "name": "Cart",
      "filters": [
        {
          "filter_type": "page",
          "operator": "is",
          "values": [
            "/cart"
          ]
        }
      ]
    }
  ],
  "created_at": 0
}