Update alert rule (partial)

Requires EDITOR. All AlertRuleInput fields optional.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

ruleId

required

string

Request Body^required

application/json

Partial — every field optional.

object

name

required

string

>= 1 characters <= 100 characters

metric

required

string

Allowed values: conversion_volume report_failure_rate report_dlq_count

baselineMode

string

default: both

Allowed values: day_over_day week_over_week both absolute

dropPct

number | null

<= 1

threshold

number | null

minSample

integer

default: 50

consecutiveTicks

integer

default: 2 >= 1 <= 10

cooldownMinutes

integer

default: 60 >= 5 <= 1440

channels

Array<string>

default:

Allowed values: webhook email

filters

object

key

additional properties

any

notifyOnResolve

boolean

default: true

enabled

boolean

default: true

Responses

200

Updated rule.

application/json

object

rule

object

key

additional properties

any

400

Param validation failed.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

404

Resource not found (or cross-tenant — same 404).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

PATCH

/api/projects/{projectId}/alert-rules/{ruleId}

1
curl --request PATCH \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/alert-rules/%3Cstring%3E \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '"<string>"'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/alert-rules/%3Cstring%3E';
2
const options = {
3
  method: 'PATCH',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '"<string>"'
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/alert-rules/%3Cstring%3E"
4

5
payload = "<string>"
6
headers = {
7
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
8
    "Content-Type": "application/json"
9
}
10

11
response = requests.patch(url, json=payload, headers=headers)
12

13
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("\"<string>\"")
9

10
response = httpx.patch(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/alert-rules/%3Cstring%3E"
13

14
  payload := strings.NewReader("\"<string>\"")
15

16
  req, _ := http.NewRequest("PATCH", 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
}

200Updated rule.

1
{
2
  "rule": {}
3
}

Update alert rule (partial)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

400

Examplegenerated

403

Examplegenerated

404

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated