Create a saved funnel (ADMIN)

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Request Body^required

application/json

object

name

required

string

>= 1 characters

description

string | null

<= 500 characters

steps

required

Each item is an event-name string OR { order?, eventName }.

Array

>= 2 items

One of:

string
object

string

>= 1 characters

windowHours

integer

default: 24 >= 1 <= 2160

Responses

201

{ funnel }

application/json

object

funnel

Saved funnel record (shape from dashboard-funnels repository).

object

string

projectId

string

name

string

description

string | null

steps

Array<object>

object

order

integer

eventName

string

windowHours

integer

key

additional properties

any

400

Invalid config

application/json

Validation error envelope (Zod). issues/details present on schema failures.

object

error

required

string

issues

Array<object>

object

key

additional properties

any

details

Array<object>

object

key

additional properties

any

Example^generated

1
{
2
  "error": "example",
3
  "issues": [
4
    {}
5
  ],
6
  "details": [
7
    {}
8
  ]
9
}

POST

/api/projects/{projectId}/funnels

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/funnels \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "description": "<string>",
8
  "steps": [
9
    "<string>"
10
  ],
11
  "windowHours": 24
12
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/funnels';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","description":"<string>","steps":["<string>"],"windowHours":24}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/funnels"
4

5
payload = {
6
    "name": "<string>",
7
    "description": "<string>",
8
    "steps": ["<string>"],
9
    "windowHours": 24
10
}
11
headers = {
12
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
13
    "Content-Type": "application/json"
14
}
15

16
response = requests.post(url, json=payload, headers=headers)
17

18
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/funnels"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"steps\": [\n    \"<string>\"\n  ],\n  \"windowHours\": 24\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/funnels"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"steps\": [\n    \"<string>\"\n  ],\n  \"windowHours\": 24\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201{ funnel }

1
{
2
  "funnel": {
3
    "id": "example",
4
    "projectId": "example",
5
    "name": "example",
6
    "description": "example",
7
    "steps": [
8
      {
9
        "order": 1,
10
        "eventName": "example"
11
      }
12
    ],
13
    "windowHours": 1
14
  }
15
}

Create a saved funnel (ADMIN)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

Request Body^required

Example^generated