Project overview KPIs (clicks/visits/events/conversions) with prev-period delta

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project id

Query Parameters

range

string

default: today

Relative window label parsed by parseOverviewRange (e.g. today, yesterday, plus other supported labels). Defaults to “today”. Determines current + previous comparison window (UTC).

Responses

200

Overview payload (dynamic aggregate shape). kpis and funnel.steps are fixed-length arrays with fixed key values (kpis: visits, conversions, conversionRate, activeLinks, totalSpent — always 5 entries; funnel.steps: clicks, visits, events, conversions, postback — always 5 entries). The service returns only the key for each entry — display labels are not part of this response and are resolved client-side via i18n, keyed off key (fix-onboarding-empty-state-defects: the previous hardcoded-Chinese label field has been removed from both arrays). channelSummary is duplicated at the top level for backwards compat and is the same array channels.top/channels.bottom are derived from. Numeric percentages are rounded to 1 decimal (x10 then /10), so they are number, not integer. kpis[].value for totalSpent is yuan (fen/100) and can be fractional; spark[].count for totalSpent is yuan rounded to an integer. Note: getOverview destructures recentConversions from the auxiliary data but does NOT include it in the response.

application/json

object

health

required

object

ingest

required

object

status

required

string

Allowed values: ok warn crit disabled

eventsInRange

required

Weighted AE event count in range (all events, including internal).

number

avgEventsPerDay

required

Math.round(eventsInRange / periodDays)

integer

postback

required

object

status

required

string

Allowed values: ok warn crit disabled

successRate

required

Percent 0-100 with 1 decimal; null when there are no conversions in range.

number | null

totalConversions

required

integer

worstChannel

required

Present only when the worst channel’s success rate is below the warn threshold (90%).

object

code

required

Conversion_reports.platform

string

rate

required

Percent 0-100, 1 decimal

number

reach

required

object

status

required

string

Allowed values: ok warn crit disabled

enabled

required

True when the project has an active email provider

boolean

incentive

required

object

status

required

string

Allowed values: ok warn crit disabled

enabled

required

boolean

alertCount

required

Number of the 4 health capsules whose status is warn or crit (0-4).

integer

kpis

required

Always 5 entries, in fixed order.

Array<object>

object

key

required

string

Allowed values: visits conversions conversionRate activeLinks totalSpent

value

required

number

prev

required

Same metric for the previous comparison window

number

spark

required

Array<object>

object

date

required

YYYY-MM-DD (UTC day bucket)

string format: date

count

required

number

unit

required

string | null

Allowed values: % yuan

drillLink

required

string | null

Allowed values: visits conversions links

funnel

required

object

steps

required

Always 5 entries, in fixed order.

Array<object>

object

key

required

string

Allowed values: clicks visits events conversions postback

count

required

number

prevCount

required

number

rate

required

Step conversion percent 0-100 with 1 decimal; null for the first step and when the previous step count is 0.

number | null

channels

required

object

top

required

First 5 of channelSummary (ordered by total conversions DESC).

Array<object>

object

platform

required

string

totalConversions

required

integer

successConversions

required

integer

successRate

required

Percent 0-100 with 1 decimal

number

bottom

required

Up to 3 channels with the lowest successRate; empty array when channelSummary has <= 1 entry.

Array<object>

object

platform

required

string

totalConversions

required

integer

successConversions

required

integer

successRate

required

Percent 0-100 with 1 decimal

number

incentive

required

object

enabled

required

boolean

counts24h

required

object

decisions

required

integer

issued

required

integer

redeemed

required

integer

budget

required

Null when no issue budget limit is configured on active campaigns.

object

issuedCount

required

integer

settledCount

required

integer

remainingPct

required

0-100

integer | null

limitCount

required

integer | null

isEmpty

required

True when the all-time Analytics Engine event count for the project is 0.

boolean

rangeLabel

required

Echo of the resolved range query param; defaults to “today”, unknown values fall through to “7d”.

string

Allowed values: today yesterday 7d 30d

channelSummary

required

Backwards-compat duplicate; top 10 platforms by conversion count in range.

Array<object>

object

platform

required

string

totalConversions

required

integer

successConversions

required

integer

successRate

required

Percent 0-100 with 1 decimal

number

_meta

required

object

queryDurationMs

required

integer

GET

/api/projects/{projectId}/overview

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

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

5
querystring = {"range":"today"}
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/overview"
4

5
params = [("range", "today")]
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/overview?range=today"
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
}

200Overview payload (dynamic aggregate shape). kpis and funnel.steps are fixed-length arrays with fixed key values (kpis: visits, conversions, conversionRate, activeLinks, totalSpent — always 5 entries; funnel.steps: clicks, visits, events, conversions, postback — always 5 entries). The service returns only the key for each entry — display labels are not part of this response and are resolved client-side via i18n, keyed off key (fix-onboarding-empty-state-defects: the previous hardcoded-Chinese label field has been removed from both arrays). channelSummary is duplicated at the top level for backwards compat and is the same array channels.top / channels.bottom are derived from. Numeric percentages are rounded to 1 decimal (x10 then /10), so they are number , not integer. kpis[].value for totalSpent is yuan (fen/100) and can be fractional; spark[].count for totalSpent is yuan rounded to an integer. Note: getOverview destructures recentConversions from the auxiliary data but does NOT include it in the response.

1
{
2
  "health": {
3
    "ingest": {
4
      "status": "ok"
5
    },
6
    "postback": {
7
      "status": "ok"
8
    },
9
    "reach": {
10
      "status": "ok"
11
    },
12
    "incentive": {
13
      "status": "ok"
14
    }
15
  },
16
  "kpis": [
17
    {
18
      "key": "visits",
19
      "unit": "%",
20
      "drillLink": "visits"
21
    }
22
  ],
23
  "funnel": {
24
    "steps": [
25
      {
26
        "key": "clicks"
27
      }
28
    ]
29
  },
30
  "rangeLabel": "today"
31
}