Buttondown logo

Filters

A filter is a single condition that can be evaluated against a Subscriber. It has a field, an operator, and a value:

{
    "field": "subscriber.tags",
    "operator": "contains",
    "value": "sub_tag_0j6hb7h40j6hb7h40j6hb7h40j"
}

The field is the path to the field on the subscriber to evaluate. The operator is the operator to use when evaluating the filter. The value is the value to compare the field to. Tag filters require the tag's ID (either a UUID or TypeID), not its name.

{
    "field": "subscriber.tags",
    "operator": "contains",
    "value": "12345678-9012-3456-7890-123456789012"
}

Fields

fieldstring

operatorstring · enum

values
  • equals

    The value is equal to the field.

  • not_equals

    The value is not equal to the field.

  • contains

    The value contains the field.

  • not_contains

    The value does not contain the field.

  • is_empty

    The value is empty.

  • is_not_empty

    The value is not empty.

  • greater_than

    The value is greater than the field.

  • less_than

    The value is less than the field.

valuestring