Event analytics summary (by day / by type / by device)

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Query Parameters

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.

Responses

200

ByDay / byType / byDevice breakdowns plus _meta. The _count sub-objects use a key that repeats the dimension name (byType → _count.eventName, byDevice → _count.deviceType); these are fixed literal keys, not dynamic. _meta.scope and _meta.scopeLabel are hardcoded constants (“EVENT” / “事件”). Internal events are excluded.

application/json

object

byDay

required

Array<object>

object

date

required

YYYY-MM-DD (UTC)

string format: date

count

required

Weighted AE event count for the day bucket

number

byType

required

Top 15 event names by count.

Array<object>

object

eventName

required

string

_count

required

object

eventName

required

number

byDevice

required

Top 10 device types by count.

Array<object>

object

deviceType

required

string

_count

required

object

deviceType

required

number

_meta

required

object

queryDurationMs

required

integer

scope

required

string

Allowed value: EVENT

scopeLabel

required

string

Allowed value: 事件

GET

/api/projects/{projectId}/analytics/events

1
curl --request GET \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/analytics/events \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/analytics/events';
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/analytics/events"
4

5
headers = {"cookie": "trackly_session=%3CYOUR_API_KEY%3E"}
6

7
response = requests.get(url, headers=headers)
8

9
print(response.json())

1
import httpx
2

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

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

7
response = httpx.get(url, cookies=cookies)
8

9
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/analytics/events"
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
}

200ByDay / byType / byDevice breakdowns plus _meta. The _count sub-objects use a key that repeats the dimension name (byType → _count.eventName , byDevice → _count.deviceType ); these are fixed literal keys, not dynamic. _meta.scope and _meta.scopeLabel are hardcoded constants (“EVENT” / “事件”). Internal events are excluded.

1
{
2
  "_meta": {
3
    "scope": "EVENT",
4
    "scopeLabel": "事件"
5
  }
6
}