Growth metric time series (roas etc.)

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Query Parameters

startDate

required

string format: date

Required.

endDate

required

string format: date

Required.

metric

string

default: roas

Responses

200

Metric series (dynamic shape). Reads the computed_metrics D1 table. metricName echoes the ?metric query param (defaults to “roas”). value column is REAL -> number. metadata is a JSON text column (text(..., {mode:"json"})) with NO schema constraint — it is whatever the metric writer stored; it is the metadata of the LAST row in the period, or null when there are no rows. trend[].date = periodStart.slice(0,10) i.e. “YYYY-MM-DD”. Missing startDate/endDate throws -> 500 {error, detail} (routes:102-110).

application/json

object

metricName

required

Echo of ?metric, default ‘roas’.

string

current

required

Last value in range; 0 when no rows.

number

average

required

Arithmetic mean of values; 0 when no rows.

number

trend

required

Array<object>

object

date

required

Period_start truncated to YYYY-MM-DD

string

value

required

number

metadata

required

Opaque JSON from computed_metrics.metadata of the latest row in range; null when there are no rows. No schema is enforced anywhere in the read path — intentionally permissive.

nullable

500

Load failed / missing date params.

application/json

object

error

string

detail

string

Example^generated

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

GET

/api/projects/{projectId}/growth/metrics

1
curl --request GET \
2
  --url 'https://retidal.com/api/projects/%3Cstring%3E/growth/metrics?startDate=%3Cstring%3E&endDate=%3Cstring%3E&metric=roas' \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

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

5
querystring = {"startDate":"<string>","endDate":"<string>","metric":"roas"}
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/growth/metrics"
4

5
params = [("startDate", "<string>"), ("endDate", "<string>"), ("metric", "roas")]
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/growth/metrics?startDate=%3Cstring%3E&endDate=%3Cstring%3E&metric=roas"
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
}

200Metric series (dynamic shape). Reads the computed_metrics D1 table. metricName echoes the ?metric query param (defaults to “roas”). value column is REAL -> number. metadata is a JSON text column ( text(..., {mode:"json"}) ) with NO schema constraint — it is whatever the metric writer stored; it is the metadata of the LAST row in the period, or null when there are no rows. trend[].date = periodStart.slice(0,10) i.e. “YYYY-MM-DD”. Missing startDate/endDate throws -> 500 {error, detail} (routes:102-110).

1
{
2
  "metricName": "example",
3
  "current": 1,
4
  "average": 1,
5
  "trend": [
6
    {
7
      "date": "example",
8
      "value": 1
9
    }
10
  ],
11
  "metadata": "example"
12
}

Growth metric time series (roas etc.)

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

500

Examplegenerated

Example^generated