Choose a version:

SegmentFilter

interface

Requires read_customers access scope.

The filters used in segment queries associated with a shop.

Anchor to FieldsFields

Anchor to localizedNamelocalizedName •String! non-null: The localized name of the filter.
Anchor to multiValuemultiValue •Boolean! non-null: Whether a file can have multiple values for a single customer.
Anchor to queryNamequeryName •String! non-null: The query name of the filter.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to SegmentAssociationFilter SegmentAssociationFilter •OBJECT: A filter that takes a value that's associated with an object. For example, the tags field is associated with the Customer object.

Show fields
Anchor to SegmentBooleanFilter SegmentBooleanFilter •OBJECT: A filter with a Boolean value that's been added to a segment query.

Show fields
Anchor to SegmentDateFilter SegmentDateFilter •OBJECT: A filter with a date value that's been added to a segment query.

Show fields
Anchor to SegmentEnumFilter SegmentEnumFilter •OBJECT: Categorical filter options for building customer segments using predefined value sets like countries, subscription statuses, or order frequencies.

For example, a "Customer Location" enum filter provides options like "United States," "Canada," and "United Kingdom."

Use this object to:

Access available categorical filter options

Understand filter capabilities and constraints

Build user interfaces for segment creation

Includes localized display names, indicates whether multiple values can be selected, and provides technical query names for API operations.

Show fields
Anchor to SegmentEventFilter SegmentEventFilter •OBJECT: A filter that's used to segment customers based on the date that an event occured. For example, the product_bought event filter allows you to segment customers based on what products they've bought.

Show fields
Anchor to SegmentFloatFilter SegmentFloatFilter •OBJECT: A filter with a double-precision, floating-point value that's been added to a segment query.

Show fields
Anchor to SegmentIntegerFilter SegmentIntegerFilter •OBJECT: A filter with an integer that's been added to a segment query.

Show fields
Anchor to SegmentStringFilter SegmentStringFilter •OBJECT: A filter with a string that's been added to a segment query.

Show fields

Was this section helpful?

{

"localizedName": "",

"multiValue": "",

"queryName": ""

}