Growth dashboard (AARRR) snapshot vs previous period

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

Growth board (dynamic shape). Object literal returned at analytics.ts:2045-2114; no explicit interface. Keys are fixed. aarrr is an array whose LENGTH/CONTENT depends on the project’s configured AARRR stages (computeAARRRFunnel maps over growth.aarrrStages, normally 5 stages: acquisition/activation/retention/ revenue/referral), but the item shape is fixed. All trend[].date are “YYYY-MM-DD” (UTC) — from formatDateParam (src/lib/date-params.ts:5-10) or buildDailyDateRange (derived.ts:49-63). change is a percentage (0 when previous == 0). coreConversionRate.current/previous are percentages 0-100; coreConversionRate.trend[].count is a percentage rounded to 1 decimal (derived from buildScopedConversionTrend, analytics.ts:443-475). _meta.conversionLabel is a CN-localized string built from the activation stage label (“率”) or the literal “核心转化率”. Error path (500): {error: string, detail: string} — routes/analytics.ts:123-131.

application/json

object

kpis

required

object

totalEvents

required

object

current

required

number

previous

required

number

change

required

Percent change vs previous period; 0 when previous is 0.

number

trend

required

Array<object>

object

date

required

UTC YYYY-MM-DD

string

count

required

number

activeUsers

required

object

current

required

number

previous

required

number

change

required

Percent change vs previous period; 0 when previous is 0.

number

trend

required

Array<object>

object

date

required

UTC YYYY-MM-DD

string

count

required

number

newUsers

required

object

current

required

number

previous

required

number

change

required

Percent change vs previous period; 0 when previous is 0.

number

trend

required

Array<object>

object

date

required

UTC YYYY-MM-DD

string

count

required

number

coreConversionRate

required

Current/previous are percentages (0-100). trend[].count is also a percentage (1 decimal), not a raw count.

object

current

required

number

previous

required

number

change

required

Percent change vs previous period; 0 when previous is 0.

number

trend

required

Array<object>

object

date

required

UTC YYYY-MM-DD

string

count

required

number

aarrr

required

One entry per configured AARRR stage (derived from the project’s growth definition; default template yields 5 stages in fixed order).

Array<object>

object

key

required

string

Allowed values: acquisition activation retention revenue referral

name

required

Stage label from the growth definition (CN by default).

string

value

required

number

conversionRate

required

Percent vs previous stage, 2 decimals; 0 when previous stage is 0.

number

topEventTrends

required

Top 5 event names by count in range.

Array<object>

object

eventName

required

string

total

required

number

trend

required

Array<object>

object

date

required

UTC YYYY-MM-DD

string

count

required

number

channelDistribution

required

Array<object>

object

name

required

string

value

required

number

deviceDistribution

required

Array<object>

object

name

required

string

value

required

number

_meta

required

object

queryDurationMs

required

integer

scope

required

string

Allowed values: EVENT SESSION VISITOR IDENTIFIED_USER ACCOUNT

requestedScope

required

string

Allowed values: EVENT SESSION VISITOR IDENTIFIED_USER ACCOUNT

scopeLabel

required

string

analysisSubjectKey

required

E.g. ‘properties.tenantId’; non-null only when scope == ACCOUNT.

string

nullable

activeLabel

required

string

newLabel

required

string

conversionLabel

required

string

500

Load failed.

application/json

object

error

string

detail

string

Example^generated

1
{
2
  "error": "example",
3
  "detail": "example"
4
}

GET

/api/projects/{projectId}/growth

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

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

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

7
response = requests.get(url, headers=headers)
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/growth"
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
}

200Growth board (dynamic shape). Object literal returned at analytics.ts:2045-2114; no explicit interface. Keys are fixed. aarrr is an array whose LENGTH/CONTENT depends on the project’s configured AARRR stages (computeAARRRFunnel maps over growth.aarrrStages, normally 5 stages: acquisition/activation/retention/ revenue/referral), but the item shape is fixed. All trend[].date are “YYYY-MM-DD” (UTC) — from formatDateParam (src/lib/date-params.ts:5-10) or buildDailyDateRange (derived.ts:49-63). change is a percentage (0 when previous == 0). coreConversionRate.current/previous are percentages 0-100; coreConversionRate.trend[].count is a percentage rounded to 1 decimal (derived from buildScopedConversionTrend, analytics.ts:443-475). _meta.conversionLabel is a CN-localized string built from the activation stage label (“ 率”) or the literal “核心转化率”. Error path (500): {error: string, detail: string} — routes/analytics.ts:123-131.

1
{
2
  "kpis": {
3
    "totalEvents": {
4
      "trend": [
5
        {
6
          "date": "2026-07-24"
7
        }
8
      ]
9
    },
10
    "activeUsers": {
11
      "trend": [
12
        {
13
          "date": "2026-07-24"
14
        }
15
      ]
16
    },
17
    "newUsers": {
18
      "trend": [
19
        {
20
          "date": "2026-07-24"
21
        }
22
      ]
23
    },
24
    "coreConversionRate": {
25
      "trend": [
26
        {
27
          "date": "2026-07-24"
28
        }
29
      ]
30
    }
31
  },
32
  "aarrr": [
33
    {
34
      "key": "acquisition"
35
    }
36
  ],
37
  "_meta": {
38
    "scope": "EVENT",
39
    "requestedScope": "EVENT"
40
  }
41
}

Growth dashboard (AARRR) snapshot vs previous period

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

500

Examplegenerated

Example^generated