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

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.

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.

SegmentBooleanFilter

•OBJECT

A filter with a Boolean value that's been added to a segment query.

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.

SegmentDateFilter

•OBJECT

A filter with a date value that's been added to a segment query.

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.

SegmentEnumFilter

•OBJECT

A filter with a set of possible values that's been added to a segment query.

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.

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.

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 parametersparameters •[SegmentEventFilterParameter!]! non-null: The parameters for an event segment filter.
Anchor to queryNamequeryName •String! non-null: The query name of the filter.
Anchor to returnValueTypereturnValueType •String! non-null: The return value type for an event segment filter.

SegmentFloatFilter

•OBJECT

A filter with a double-precision, floating-point value that's been added to a segment query.

Anchor to localizedNamelocalizedName •String! non-null: The localized name of the filter.
Anchor to maxRangemaxRange •Float: The maximum range a filter can have.
Anchor to minRangeminRange •Float: The minimum range a filter can have.
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.

SegmentIntegerFilter

•OBJECT

A filter with an integer that's been added to a segment query.

Anchor to localizedNamelocalizedName •String! non-null: The localized name of the filter.
Anchor to maxRangemaxRange •Float: The maximum range a filter can have.
Anchor to minRangeminRange •Float: The minimum range a filter can have.
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.

SegmentStringFilter

•OBJECT

A filter with a string that's been added to a segment query.

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?