Publish a new immutable metric version (optionally trigger backfill)

Auth: session ADMIN role, or ApiKeyAuth with scope metrics:write.

Authorizations

SessionCookie
ApiKeyAuth

Parameters

Path Parameters

projectId

required

string

metricId

required

string

Request Body^required

application/json

object

aggregationJson

required

JSON-encoded MetricAggregationDSL (re-validated).

string

>= 2 characters

triggerBackfill

boolean

backfillFrom

Unix ms.

integer

>= 1

backfillTo

Unix ms.

integer

>= 1

backfillSource

Explicit data source override; when omitted, auto-selected by lake coverage (ae never auto-selected).

string

Allowed values: lake transactions ae

Responses

200

{ version, created, backfillJob? }

application/json

object

key

additional properties

any

422

Validation / bad aggregationJson / DSL invalid

application/json

Validation error envelope (Zod). issues/details present on schema failures.

object

error

required

string

issues

Array<object>

object

key

additional properties

any

details

Array<object>

object

key

additional properties

any

Example^generated

1
{
2
  "error": "example",
3
  "issues": [
4
    {}
5
  ],
6
  "details": [
7
    {}
8
  ]
9
}

500

Publish_failed

application/json

object

error

string

detail

string

Example^generated

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

POST

/api/projects/{projectId}/metric-definitions/{metricId}/publish

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/metric-definitions/%3Cstring%3E/publish \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "aggregationJson": "<string>",
7
  "triggerBackfill": true,
8
  "backfillFrom": 0,
9
  "backfillTo": 0,
10
  "backfillSource": "lake"
11
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/metric-definitions/%3Cstring%3E/publish';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"aggregationJson":"<string>","triggerBackfill":true,"backfillFrom":0,"backfillTo":0,"backfillSource":"lake"}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/metric-definitions/%3Cstring%3E/publish"
4

5
payload = {
6
    "aggregationJson": "<string>",
7
    "triggerBackfill": True,
8
    "backfillFrom": 0,
9
    "backfillTo": 0,
10
    "backfillSource": "lake"
11
}
12
headers = {
13
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
14
    "Content-Type": "application/json"
15
}
16

17
response = requests.post(url, json=payload, headers=headers)
18

19
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/metric-definitions/%3Cstring%3E/publish"
5

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

8
payload = json.loads("{\n  \"aggregationJson\": \"<string>\",\n  \"triggerBackfill\": true,\n  \"backfillFrom\": 0,\n  \"backfillTo\": 0,\n  \"backfillSource\": \"lake\"\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/metric-definitions/%3Cstring%3E/publish"
13

14
  payload := strings.NewReader("{\n  \"aggregationJson\": \"<string>\",\n  \"triggerBackfill\": true,\n  \"backfillFrom\": 0,\n  \"backfillTo\": 0,\n  \"backfillSource\": \"lake\"\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

200{ version, created, backfillJob? }

1
{}

Publish a new immutable metric version (optionally trigger backfill)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

422

Examplegenerated

500

Examplegenerated

Request Body^required

Example^generated

Example^generated