Per-platform conversion delivery stats

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Query Parameters

startDate

string format: date

endDate

string format: date

Responses

200

{ stats }. Some keys are dynamic — stats is a MAP keyed by adPlatformConfig id (dynamic keys), NOT an array. Every ad-platform config of the project gets an entry, pre-seeded with zeros, so values are always fully populated (never partial/null). Returns {"stats": {}} when the project has no ad platform configs. successRate is an INTEGER percentage 0-100 (Math.round of successConversions/totalConversions*100), 0 when totalConversions === 0. totalPV counts visit_attribution rows; uniqueVisitors is the distinct visitorId count for those rows. totalClicks is the summed shortLinks.clickCount and is NOT date-filtered (startDate/endDate only filter visits and conversions). No credentials appear in this response.

application/json

object

stats

required

Keyed by ad platform config id (dynamic keys).

object

key

additional properties

object

totalClicks

required

integer

uniqueVisitors

required

integer

totalPV

required

integer

totalConversions

required

integer

successConversions

required

integer

successRate

required

Whole-number percentage 0-100.

integer

GET

/api/projects/{projectId}/platforms/stats

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

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/platforms/stats';
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/platforms/stats"
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/platforms/stats"
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/platforms/stats"
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{ stats }. Some keys are dynamic — stats is a MAP keyed by adPlatformConfig id (dynamic keys), NOT an array. Every ad-platform config of the project gets an entry, pre-seeded with zeros, so values are always fully populated (never partial/null). Returns {"stats": {}} when the project has no ad platform configs. successRate is an INTEGER percentage 0-100 (Math.round of successConversions/totalConversions*100), 0 when totalConversions === 0. totalPV counts visit_attribution rows; uniqueVisitors is the distinct visitorId count for those rows. totalClicks is the summed shortLinks.clickCount and is NOT date-filtered (startDate/endDate only filter visits and conversions). No credentials appear in this response.

1
{
2
  "stats": {
3
    "additionalProperty": {
4
      "totalClicks": 1,
5
      "uniqueVisitors": 1,
6
      "totalPV": 1,
7
      "totalConversions": 1,
8
      "successConversions": 1,
9
      "successRate": 1
10
    }
11
  }
12
}