Home
Developer Docs

Create a new dataset query filter

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

Create a new query filter for a specific dataset

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

The ID of the dataset

Query Params
boolean

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

Body Params
string
required
length between 1 and 255

Human-readable name for the filter

string

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. Exactly one of filter or pipeline must be provided when creating a filter.

string
length ≥ 1

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

Exactly one of filter or pipeline must be provided when creating a filter. pipeline is preferred for new integrations, as filter may be removed in a future API version.

boolean
Defaults to false

Whether the filter is disabled by the user

date-time

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

date-time

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

string

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