Rules

List the rules Prelude maintains

Beta. The request and response shapes may still change.

List the Prelude-authored rules every customer shares. These are the shared library a recipe may draw on alongside your own rules: reference one in a recipe by its identifier, give it a weight, and it scores like any other.

A managed rule is returned without its expression, and with a description in place of a name. A managed rule reads only Prelude signals, so it can never reference a recipe’s attributes or parameters.

GET

watch

management

rules

managed

List managed rules

curl --request GET \
  --url https://api.prelude.dev/v2/watch/management/rules/managed \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/watch/management/rules/managed', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/watch/management/rules/managed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/watch/management/rules/managed"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/watch/management/rules/managed")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "rules": [
    {
      "id": "rul_01jc0t6fwwfgfsq1md24mhyztj",
      "type": "MANAGED",
      "description": "Flags traffic arriving from a residential proxy corroborated by a second source."
    }
  ],
  "next_cursor": "rul_01jc0t6fwwfgfsq1md24mhyztj"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

Managed rules are Prelude’s own: a shared library every customer can score over and none can edit. Name one in a recipe by its identifier, give it a weight, and it behaves like a rule you wrote.

What you get, and what you don’t

A managed rule is returned with an identifier, a type, and a description. It carries no expression, and a description stands in for the name. The identifier is always disclosed, which is what matters in practice: a rule whose condition you can’t read is still one you can reweight, switch off, or ask us about.

What they can read

A managed rule reads Prelude signals only. It can never reference a recipe’s attr. or param. names - a recipe referencing one that does is refused, because a shared rule bound to one customer’s recipe stops being shared. Writing to a managed rule’s identifier is refused with managed_rule_read_only. Reading one through Get a rule answers 404: it exists, but not as something you own.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

integer

default:50

Maximum number of rules to return per page. A larger value is clamped to 200 rather than refused.

Required range: 1 <= x <= 200

cursor

string

Pagination cursor from the previous response.

Response

rules

object[]

required

Show child attributes

next_cursor

string

Pass this back as cursor for the next page. Absent on the last page.

Example:

"rul_01jc0t6fwwfgfsq1md24mhyztj"

List managed rules

curl --request GET \
  --url https://api.prelude.dev/v2/watch/management/rules/managed \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/watch/management/rules/managed', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/watch/management/rules/managed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/watch/management/rules/managed"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/watch/management/rules/managed")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "rules": [
    {
      "id": "rul_01jc0t6fwwfgfsq1md24mhyztj",
      "type": "MANAGED",
      "description": "Flags traffic arriving from a residential proxy corroborated by a second source."
    }
  ],
  "next_cursor": "rul_01jc0t6fwwfgfsq1md24mhyztj"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

Documentation

API Reference

Management API

List the rules Prelude maintains

What you get, and what you don’t

What they can read

Authorizations

Query Parameters

Response

​What you get, and what you don’t

​What they can read

Authorizations

Query Parameters

Response

What you get, and what you don’t

What they can read