Update a drop filter

patch

https://{customerid}.observeinc.com/v1/ingest/filters/{id}

Merge-patch update of a drop filter. Only fields explicitly present in the body are changed; the source dataset cannot be changed. To toggle the filter, send {"enabled": true} or {"enabled": false}. If the OPAL pipeline is provided and fails to compile, the request is rejected with a 400.
Filters with a non-null managedBy are owned by an app or other managing object and cannot be updated through this endpoint.
Allow 1-2 minutes for the change to take effect on the ingest path.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the drop filter.

Body Params

Merge-patch payload (RFC 7396). Only fields explicitly present are updated; omitted fields keep their current value. description, iconUrl, and layout accept an explicit null to clear them. label, pipeline, dropRate, and enabled are not nullable — sending null for any of those is rejected with a 400.

label

string

Display name of the filter.

description

string | null

Optional human-readable description. null clears it.

iconUrl

uri | null

Optional icon shown in the UI. null clears it.

pipeline

string

OPAL pipeline expression defining the filter predicate. Compiled against the source dataset's schema; compilation failure returns a 400.

layout

object | null

Reserved for UI state, never interpreted by Observe. null clears it.

dropRate

double

0 to 1

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

enabled

boolean

Whether the filter is actively dropping observations. Send this field alone to enable or disable an existing filter.

Responses

Language

Credentials

Bearer

Authorization: Bearer <customerid> <apitoken>

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Drop filter updated successfully

400Bad request

401Unauthorized

403Forbidden

404Resource not found

429Rate limit reached

5XXInternal server error