Get a metric definition with version history

Auth: session VIEWER role, or ApiKeyAuth with scope metrics:read.

Authorizations

SessionCookie
ApiKeyAuth

Parameters

Path Parameters

projectId

required

string

metricId

required

string

Responses

200

{ metric, versions }

application/json

object

key

additional properties

any

404

Metric_not_found

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

GET

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

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

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/metric-definitions/%3Cstring%3E';
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/metric-definitions/%3Cstring%3E"
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/metric-definitions/%3Cstring%3E"
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/metric-definitions/%3Cstring%3E"
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{ metric, versions }

1
{}

Get a metric definition with version history

Authorizations

Parameters

Path Parameters

Responses

200

404

Examplegenerated

Example^generated