Create a metric definition (draft)

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

Authorizations

SessionCookie
ApiKeyAuth

Parameters

Path Parameters

projectId

required

string

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 100 characters

description

string

<= 500 characters

eventName

required

string

>= 1 characters <= 100 characters

aggregation

required

Metric aggregation DSL. aggregator is one of METRIC_AGGREGATORS (count/sum/max/unique/…); non-count aggregators require fieldPath. fieldPaths are allowlist-validated.

object

aggregator

required

string

fieldPath

string

filter

object

conditions

required

Array<object>

>= 1 items

object

field

required

string

required

One of FILTER_OPS.

string

value

required

groupBy

object

keys

required

Array<string>

>= 1 items

window

object

type

required

string

Allowed values: billing_period rolling_days

days

integer

>= 1

Responses

201

{ metric }

application/json

object

metric

object

key

additional properties

any

422

Validation failed

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
}

POST

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

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/metric-definitions \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "description": "<string>",
8
  "eventName": "<string>",
9
  "aggregation": {
10
    "aggregator": "<string>",
11
    "fieldPath": "<string>",
12
    "filter": {
13
      "conditions": [
14
        {
15
          "field": "<string>",
16
          "op": "<string>",
17
          "value": "<string>"
18
        }
19
      ]
20
    },
21
    "groupBy": {
22
      "keys": [
23
        "<string>"
24
      ]
25
    },
26
    "window": {
27
      "type": "billing_period",
28
      "days": 0
29
    }
30
  }
31
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/metric-definitions';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","description":"<string>","eventName":"<string>","aggregation":{"aggregator":"<string>","fieldPath":"<string>","filter":{"conditions":[{"field":"<string>","op":"<string>","value":"<string>"}]},"groupBy":{"keys":["<string>"]},"window":{"type":"billing_period","days":0}}}'
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"
4

5
payload = {
6
    "name": "<string>",
7
    "description": "<string>",
8
    "eventName": "<string>",
9
    "aggregation": {
10
        "aggregator": "<string>",
11
        "fieldPath": "<string>",
12
        "filter": { "conditions": [
13
                {
14
                    "field": "<string>",
15
                    "op": "<string>",
16
                    "value": "<string>"
17
                }
18
            ] },
19
        "groupBy": { "keys": ["<string>"] },
20
        "window": {
21
            "type": "billing_period",
22
            "days": 0
23
        }
24
    }
25
}
26
headers = {
27
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
28
    "Content-Type": "application/json"
29
}
30

31
response = requests.post(url, json=payload, headers=headers)
32

33
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"eventName\": \"<string>\",\n  \"aggregation\": {\n    \"aggregator\": \"<string>\",\n    \"fieldPath\": \"<string>\",\n    \"filter\": {\n      \"conditions\": [\n        {\n          \"field\": \"<string>\",\n          \"op\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    },\n    \"groupBy\": {\n      \"keys\": [\n        \"<string>\"\n      ]\n    },\n    \"window\": {\n      \"type\": \"billing_period\",\n      \"days\": 0\n    }\n  }\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"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"eventName\": \"<string>\",\n  \"aggregation\": {\n    \"aggregator\": \"<string>\",\n    \"fieldPath\": \"<string>\",\n    \"filter\": {\n      \"conditions\": [\n        {\n          \"field\": \"<string>\",\n          \"op\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    },\n    \"groupBy\": {\n      \"keys\": [\n        \"<string>\"\n      ]\n    },\n    \"window\": {\n      \"type\": \"billing_period\",\n      \"days\": 0\n    }\n  }\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
}

201{ metric }

1
{
2
  "metric": {}
3
}

Create a metric definition (draft)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

422

Examplegenerated

Request Body^required

Example^generated