Create a drop filter

Creates a drop filter. The OPAL pipeline is compiled against the source
dataset's schema; if compilation fails the request is rejected with a
400 whose error body details the compiler errors.

A dataset accepts at most 100 drop filters. Creating the 101st returns
a 400. Use POST /v1/ingest/filters/validate to check a pipeline
before creating the filter.

Allow 1-2 minutes for a new filter to take effect on the ingest path.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Fields for a new drop filter.

string
required

Display name of the filter.

string

Optional human-readable description.

uri

Optional icon shown alongside the filter in the UI.

sourceDataset
object
required

Source dataset reference. Only the id is consumed; any record payload is ignored. Cannot be changed after creation.

string
required

OPAL pipeline expression defining the filter predicate. Observations matching the pipeline are candidates for dropping, subject to dropRate.

layout
object

Reserved for UI state. Stored and returned verbatim, never interpreted by Observe. Safe to omit.

double
0 to 1

Fraction (0.0-1.0) of matching observations to drop. 1.0 = drop all matches; 0.0 = drop none. Default 1.0 when omitted.

boolean

Whether the filter starts actively dropping observations. Default true when omitted.

Responses

Language
Credentials
Bearer
Authorization: Bearer <customerid> <apitoken>
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json