Paginated raw event feed with rich filtering

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Query Parameters

page

integer

default: 1 >= 1

pageSize

integer

default: 20 >= 1 <= 100

startDate

string format: date

Inclusive window start (YYYY-MM-DD). Parsed with parseDateRangeParams; when either startDate or endDate is missing/invalid the route falls back to a rolling default window (30 days for events/visits/attribution, 7 days for growth).

endDate

string format: date

Inclusive window end (YYYY-MM-DD). See startDate for fallback behavior.

search

string

eventName

string

shortLinkId

string

adPlatformConfigId

string

utmSource

string

utmMedium

string

utmCampaign

string

utmTerm

string

utmContent

string

pkey{N}

string

Property filter key for the Nth filter (N=1..5), paired with pop{N} (operator) and pval{N} (value). Up to 5 property filters (pkey1/pop1/pval1 … pkey5/pop5/pval5).

Responses

200

Paginated event feed. properties is the parsed per-event propertiesJson blob — a genuinely free-form user-supplied object (arbitrary keys/values), so it stays permissive. serverTimestamp comes from the Analytics Engine toDateTime(clientTimestampMs/1000) expression, so it is a ClickHouse datetime string “YYYY-MM-DD HH:MM:SS” (UTC, space separator, no timezone suffix) — NOT RFC3339. id is a synthetic composite “:::<sessionId|‘’>:”. When utmTerm/utmContent filters are supplied but match no attribution rows, the endpoint returns events=[] and total=0 while still returning the filter option lists.

application/json

object

events

required

Array<object>

object

required

string

eventName

required

string

visitorId

required

string

userId

required

string | null

sessionId

required

string | null

required

string | null

country

required

string | null

deviceType

required

Defaults to “UNKNOWN” when absent

string

utmSource

required

string | null

utmMedium

required

string | null

utmCampaign

required

string | null

utmTerm

required

string | null

utmContent

required

string | null

serverTimestamp

required

UTC datetime, ClickHouse format “YYYY-MM-DD HH:MM:SS”

string

properties

required

Free-form event properties supplied by the ingesting client; null when absent or unparsable.

object | null

shortLinkId

required

string | null

adPlatformConfigId

required

string | null

shortLink

required

object

required

string

name

required

string | null

shortCode

required

string

adPlatformConfig

required

object

required

string

name

required

string

platform

required

string

total

required

Total matching rows (AE COUNT()), not the page size

integer

eventNames

required

Distinct configured event names for the project (filter options).

Array<string>

links

required

Short-link filter options for the project.

Array<object>

object

required

string

name

required

string | null

shortCode

required

string

pixels

required

Ad-platform config (pixel) filter options for the project.

Array<object>

object

required

string

name

required

string

platform

required

string

GET

/api/projects/{projectId}/events

1
curl --request GET \
2
  --url 'https://retidal.com/api/projects/%3Cstring%3E/events?page=1&pageSize=20' \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/events?page=1&pageSize=20';
2
const options = {method: 'GET', headers: {cookie: 'trackly_session=%3CYOUR_API_KEY%3E'}};
3

4
try {
5
  const response = await fetch(url, options);
6
  const data = await response.json();
7
  console.log(data);
8
} catch (error) {
9
  console.error(error);
10
}

1
import requests
2

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

5
querystring = {"page":"1","pageSize":"20"}
6

7
headers = {"cookie": "trackly_session=%3CYOUR_API_KEY%3E"}
8

9
response = requests.get(url, headers=headers, params=querystring)
10

11
print(response.json())

1
import httpx
2

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

5
params = [("page", "1"), ("pageSize", "20")]
6

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

9
response = httpx.get(url, params=params, cookies=cookies)
10

11
print(response.json())

1
package main
2

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

9
func main() {
10

11
  url := "https://retidal.com/api/projects/%3Cstring%3E/events?page=1&pageSize=20"
12

13
  req, _ := http.NewRequest("GET", url, nil)
14

15
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
16

17
  res, _ := http.DefaultClient.Do(req)
18

19
  defer res.Body.Close()
20
  body, _ := io.ReadAll(res.Body)
21

22
  fmt.Println(res)
23
  fmt.Println(string(body))
24

25
}

200Paginated event feed. properties is the parsed per-event propertiesJson blob — a genuinely free-form user-supplied object (arbitrary keys/values), so it stays permissive. serverTimestamp comes from the Analytics Engine toDateTime(clientTimestampMs/1000) expression, so it is a ClickHouse datetime string “YYYY-MM-DD HH:MM:SS” (UTC, space separator, no timezone suffix) — NOT RFC3339. id is a synthetic composite “ : : :<sessionId|‘’>: ”. When utmTerm/utmContent filters are supplied but match no attribution rows, the endpoint returns events=[] and total=0 while still returning the filter option lists.

1
{
2
  "events": [
3
    {
4
      "id": "example",
5
      "eventName": "example",
6
      "visitorId": "example",
7
      "userId": "example",
8
      "sessionId": "example",
9
      "ip": "example",
10
      "country": "example",
11
      "deviceType": "example",
12
      "utmSource": "example",
13
      "utmMedium": "example",
14
      "utmCampaign": "example",
15
      "utmTerm": "example",
16
      "utmContent": "example",
17
      "serverTimestamp": "example",
18
      "properties": "example",
19
      "shortLinkId": "example",
20
      "adPlatformConfigId": "example",
21
      "shortLink": {
22
        "id": "example",
23
        "name": "example",
24
        "shortCode": "example"
25
      },
26
      "adPlatformConfig": {
27
        "id": "example",
28
        "name": "example",
29
        "platform": "example"
30
      }
31
    }
32
  ],
33
  "total": 1,
34
  "eventNames": [
35
    "example"
36
  ],
37
  "links": [
38
    {
39
      "id": "example",
40
      "name": "example",
41
      "shortCode": "example"
42
    }
43
  ],
44
  "pixels": [
45
    {
46
      "id": "example",
47
      "name": "example",
48
      "platform": "example"
49
    }
50
  ]
51
}