segments_read
Returns
required
Static grammar for dynamic segment conditions. Same for every store except that some activities are platform-specific. Does not include live tags, products, or customers — those come from segmentTokenFieldOptions.
Show fields
Show fields
required
Allowed
type values on each condition.JSON Schema for the
conditions object accepted by createDynamicSegment and updateDynamicSegment, generated from the same Zod schema the writer validates.required
Allowed
conjunction (tree) and operator (block) values.required
The CUSTOM_EVENT condition shape.
required
Activity kinds for CUSTOMER_ACTIVITY conditions, including platform variants.
Show fields
Show fields
required
Grouping in the builder.
[String!]!
required
Stored
count.operator values (numeric compare).String!
required
What the activity records.
required
Filters on the activity (
event_filters). Empty when the activity has no filterable properties.Show fields
Show fields
required
Grouping in the builder.
required
Which comparison object
whereCondition must use.String!
required
What the field measures.
String!
required
Stable id to put on
whereCondition.dimension (attributes) or event_filters[].dimension (activities).String!
required
Merchant-facing name.
Boolean!
required
If true, list allowed values with
segmentTokenFieldOptions before writing the condition.[String!]!
required
Stored
comparison.operator values for this data type. Empty for boolean and custom-field (those pick a nested comparison).Int
Parent tokens required in
prerequisiteValues. Null: none. 0 (custom-fields): list declarations with no prerequisites, then pass [declarationId] to list values. Country before state is 1; country+state before city is 2.How to present a numeric value. Null when not numeric.
String!
required
Stored as
event on a customer_activity condition.String!
required
Merchant-facing name, including platform when relevant.
required
Platform that emits this activity.
[String!]!
required
Stored
timeframe.type values for this activity.required
Fields for CUSTOMER_ATTRIBUTE conditions.
Show fields
Show fields
required
Grouping in the builder.
required
Which comparison object
whereCondition must use.String!
required
What the field measures.
String!
required
Stable id to put on
whereCondition.dimension (attributes) or event_filters[].dimension (activities).String!
required
Merchant-facing name.
Boolean!
required
If true, list allowed values with
segmentTokenFieldOptions before writing the condition.[String!]!
required
Stored
comparison.operator values for this data type. Empty for boolean and custom-field (those pick a nested comparison).Int
Parent tokens required in
prerequisiteValues. Null: none. 0 (custom-fields): list declarations with no prerequisites, then pass [declarationId] to list values. Country before state is 1; country+state before city is 2.How to present a numeric value. Null when not numeric.
required
Operator lists keyed by field data type.
Show fields
Show fields
required
The field data type these operators apply to.
[String!]!
required
Stored operator strings for this data type.
Example
query {
segmentConditionCatalog {
conditionKinds
conditionsJsonSchema
conjunctions
}
}