Skip to main content
POST
Create a filter definition for a project defined event

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the project defined event

Body

application/json
variable_name
string
required

The variable name of the filter definition. Must start with event.. If a filter definition with this variable_name already exists for the project defined event (and business, if provided), it is updated instead of created

label
string
required

The label of the filter definition

type
enum<string>
required

The type of the filter definition

Available options:
select,
text,
number,
boolean,
datetime,
currency,
array_of_known
business
string

The ID of a business. When provided, the filter definition is created for that business only (and enabled) and overrides the project defined event's filter definition with the same variable_name. When omitted, the filter definition is created at the project defined event level and starts disabled

options
The Filter Definition Option object · object[]

The options of the filter definition. Required if the type is select or array_of_known

Response

200 - application/json

The created or updated FilterDefinition object

id
string
required

The ID of the filter definition

label
string
required

The label of the filter definition

variable_name
string
required

The variable name of the filter definition

type
enum<string>
required

The type of the filter definition

Available options:
select,
text,
number,
boolean,
datetime,
currency,
array_of_known
enabled
boolean
required

Whether the filter definition is enabled

options
The Filter Definition Option object · object[]

The options for the select dropdown