Paginated visitor directory

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Query Parameters

page

integer

default: 1 >= 1 <= 10000

pageSize

integer

default: 20 >= 1 <= 100

search

string

startDate

string format: date

endDate

string format: date

Responses

200

{ visitors: […], total }. Handler explicitly re-projects to {visitors, total} — no page/pageSize echoed back. Visitor aggregate rows come from Analytics Engine; firstSeen/lastSeen are passed through normalizeUtcTimestamp (ISO-8601 UTC, falls back to the raw DB/AE string if unparseable). eventCount is coerced to number; visitCount/conversionCount default to 0 when absent. userId is null for unidentified visitors.

application/json

object

total

required

Total matching visitors (before pagination).

integer

visitors

required

Array<object>

object

visitorId

required

string

userId

required

string

nullable

firstSeen

required

ISO-8601 UTC timestamp.

string

lastSeen

required

ISO-8601 UTC timestamp.

string

eventCount

required

integer

visitCount

required

integer

conversionCount

required

integer

GET

/api/projects/{projectId}/visitors

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

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/visitors?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/visitors"
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/visitors"
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/visitors?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
}

200{ visitors: […], total }. Handler explicitly re-projects to {visitors, total} — no page/pageSize echoed back. Visitor aggregate rows come from Analytics Engine; firstSeen/lastSeen are passed through normalizeUtcTimestamp (ISO-8601 UTC, falls back to the raw DB/AE string if unparseable). eventCount is coerced to number; visitCount/conversionCount default to 0 when absent. userId is null for unidentified visitors.

1
{
2
  "total": 1,
3
  "visitors": [
4
    {
5
      "visitorId": "example",
6
      "userId": "example",
7
      "firstSeen": "example",
8
      "lastSeen": "example",
9
      "eventCount": 1,
10
      "visitCount": 1,
11
      "conversionCount": 1
12
    }
13
  ]
14
}