Skip to main content
POST
Preview a rule

Authorizations

Authorization
string
header
required

Path Parameters

project_id
string
required

Body

application/json
rule
object
required
page
integer
default:1
page_size
integer
default:25

Maximum 200.

Response

A condition that fails validation still returns 200, with valid false and the reason in error.

valid
boolean
error
string | null
suggested_window_member_scope
enum<string>

Present when the condition contains a windowed aggregate. Which scope this condition means by acting on the whole window: repeats when it tests MIN = MAX over one data point and window, so the value opening a run is kept, and all otherwise. Send it back as window_member_scope rather than deriving the shape yourself.

Available options:
all,
repeats