Home
Developer Docs

Update a dataset query filter

patch
https://{customerid}.observeinc.com/v1/datasets//query-filters/

Update an existing query filter using JSON Merge Patch semantics

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

The ID of the dataset

string
required

The ID of the query filter to update

Query Params
boolean

Whether to expand resources referenced in the response to include additional fields

Body Params
string
length between 1 and 255

Human-readable name for the filter

string | null

Long-form description of the filter

string
length ≥ 1

Legacy OPAL boolean expression string for the filter predicate (without the leading filter verb).

Deprecated in favor of pipeline and may be removed in a future API version. When updating a filter's semantics, a request may provide either filter or pipeline, but not both.

string
length ≥ 1

Canonical OPAL pipeline snippet for the filter. May contain only filter verbs (and comments).

When updating a filter's semantics, a request may provide either filter or pipeline, but not both. pipeline is preferred, as filter may be removed in a future API version.

boolean

Whether the filter is disabled by the user

date-time | null

Activation window start time (inclusive). If omitted, the filter applies from negative infinity (unbounded from the past).

date-time | null

Activation window end time (exclusive). If omitted, the filter applies to positive infinity (unbounded to the future).

string | null

UI layout/metadata for the filter builder. This field is used by the Observe UI and should be omitted by other clients.

Responses

Updated about 2 hours ago

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

Updated about 2 hours ago