Skip to main content
PATCH
/
v3
/
evaluator-rules
/
{evaluator_rule_id}
Update Rule Evaluator
curl --request PATCH \
  --url https://api.example.com/v3/evaluator-rules/{evaluator_rule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "sampling_rate": 0.5
}
'
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "evaluator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "evaluator_name": "<string>",
    "evaluator_type_display_name": "<string>",
    "mapped_input_keys": {},
    "filters": {
      "rules": []
    },
    "outputs": [
      {
        "name": "<string>",
        "possible_values": [
          "<string>"
        ]
      }
    ],
    "enabled": true,
    "backfill": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "backfill_start_time": "2023-11-07T05:31:56Z"
    },
    "sampling_rate": 0.5,
    "application": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
evaluator_rule_id
string<uuid>
required

Path parameter for unique identifier of a Rule evaluator

Body

application/json

Partial update. Any subset of fields may be supplied. At least one field must be present. To pause evaluation entirely, set enabled to false instead of supplying a small sampling_rate.

​
enabled
boolean

Disable or enable a Rule evaluator

​
sampling_rate
number<float>

New sampling fraction in (0.0, 1.0].

Required range: 0 < x <= 1

Response

Update Rule evaluator

Response object for standard API responses.

​
api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
​
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
​
data
object

Rule Evaluator