Skip to content
Clics privacy-friendly cookieless web analytics documentation
Esc
↑↓navigate↵open⌘Jpreview

List conversion funnels for a Clics project via REST

Copy page
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

List conversion funnels for a Clics project via REST

List project conversion funnels.

GET/v1/projects/{project_id}/funnels
Authorization
AuthorizationBearer token (API key) · headerrequired
Path parameters
project_idstringrequired
Clics project ID.
min length 1
Query parameters
env_idstring
Optional environment. Defaults to `production`. Use `development` for localhost/dev traffic.
default: "production"
Allowed:productiondevelopment
cursorstring
Optional pagination cursor from a previous response.
limitinteger
Optional page size (1–100). Defaults to the API page size.
min 1 · max 100
Responses
200Paginated funnels.
funnelsobject[]required
Show properties
Array of object
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
metaobjectrequired
Show properties
cursorstring | nullrequired
is_donebooleanrequired
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 GET "https://api.clics.dev/v1/projects/k17abc123/funnels" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "funnels": [
    {
      "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
    }
  ],
  "meta": {
    "cursor": "string",
    "is_done": true
  }
}