# Update segment Update a segment. Endpoint: PATCH /entities/segments/{id} Version: 1.0.0 ## Path parameters: - `id` (integer, required) Segment to update ## Request fields (application/vnd.treasuredata.v1+json): - `id` (string) - `type` (string) Enum: "segment-batch", "segment-realtime", "segment-funnel-stage" - `attributes` (object) - `attributes.name` (string) - `attributes.description` (string,null) - `attributes.rule` (any) - `conditions` (array, required) - `conditions` (array, required) - `arrayMatching` (any, required) — one of: - variant 3: - `atLeast` (number, required) - variant 4: - `atMost` (number, required) - variant 5: - `exactly` (number, required) - `exclude` (boolean, required) - `leftValue` (any, required) — one of: - partial_v5_rule.yaml-v5IonRule-attributeNameValue: - `name` (string, required) - partial_v5_rule.yaml-v5IonRule-customerGroupAttributeValue: - `customerGroup` (string, required) - `name` (string, required) - partial_v5_rule.yaml-v5IonRule-aggregationValue: - `aggregation` (any, required) — one of: - variant 1: - `column` (string, required) - `groupingColumns` (array) - `type` (string, required) Enum: "Sum", "Min", "Max", "Average" - variant 2: - `groupingColumns` (array, required) - `type` (string, required) Enum: "Count" - variant 3: - `columns` (array, required) - `type` (string, required) Enum: "CountDistinct" - variant 4: - `column` (string, required) - `groupingColumns` (array) - `orderColumn` (string, required) - `type` (string, required) Enum: "First", "Last" - `filter` (any, required) — one of: - partial_v5_rule.yaml-v5IonRule-andFilter: - `conditions` (array, required) - `conditions` (array, required) - `type` (string, required) Enum: "Or" - `type` (string, required) Enum: "And" - partial_v5_rule.yaml-v5IonRule-orFilter: - `conditions` (array, required) - `conditions` (array, required) - `type` (string, required) Enum: same as `type` in "partial_v5_rule.yaml-v5IonRule-andFilter" (1 values) - `type` (string, required) Enum: same as `type` (1 values) - `source` (object, required) - `source.name` (string, required) - `window` (object) - `window.duration` (object, required) - `window.duration.day` (number) - `window.duration.hour` (number) - `window.duration.minute` (number) - `window.duration.second` (number) - `window.type` (string, required) Enum: "TimeSliding" - `limit` (object) - `limit.number` (number, required) - `limit.orderColumns` (array) — one of: - variant 1: - `column` (string, required) - `order` (string, required) Enum: "ascending", "descending" - `type` (string, required) Enum: "Column" - variant 2: - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: "Aggregation" - `limit.type` (string, required) Enum: "Count", "Percent" - `operator` (any, required) — one of: - variant 1: - `not` (boolean, required) - `rightValue` (object, required) - `rightValue.last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `rightValue.unit` (string, required) Enum: "year", "quarter", "month", "week", "day", "hour", "minute", "second" - `type` (string, required) Enum: "GreaterEqual" - variant 3: - `not` (boolean, required) - `rightValue` (object, required) - `rightValue.timestamp` (string, required) - `type` (string, required) Enum: "Equal" - variant 4: - `not` (boolean, required) Enum: false - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: "Greater" - variant 5: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (object, required) - `rightValue.timestamp` (string, required) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 6: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: "Less" - variant 7: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: "LessEqual" - variant 8: - `maxValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `minValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `not` (boolean, required) - `type` (string, required) Enum: "Between" - variant 9: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 10: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: "IsNull" - variant 11: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: "In" - variant 12: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 4" (1 values) - variant 13: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 6" (1 values) - variant 14: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 15: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 7" (1 values) - variant 16: - `maxValue` (any, required) - `minValue` (any, required) - `not` (boolean, required) - `rightValue` (number, required) - `type` (string, required) Enum: same as `type` in "variant 8" (1 values) - variant 17: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: "Contain" - variant 18: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: "StartWith" - variant 19: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: "EndWith" - variant 20: - `not` (boolean, required) - `rightValue` (string, required) - `type` (string, required) Enum: "Regexp" - `type` (string, required) Enum: "Value" - `description` (string) - `expr` (string) - `type` (string, required) Enum: "Or", "And", "Composite" - `expr` (string) - `limit` (object) - `limit.number` (number, required) - `limit.orderColumns` (array) — one of: - variant 1: - `column` (string, required) - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 2: - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - `limit.type` (string, required) Enum: same as `limit.type` (2 values) - `type` (string, required) Enum: same as `type` (3 values) - `attributes.funnel_stage` (object) required if type is segment-funnel-stage to create segment as a rule of funnel_stage - `attributes.funnel_stage.funnel_id` (integer) - `attributes.funnel_stage.stage_id` (integer) - `attributes.segmentInsightDashboardId` (integer,null) - `relationships` (object) - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: "folder-segment" ## Response 200 fields (application/vnd.treasuredata.v1+json): - `data` (any, required) — one of: - BatchSegmentJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "segment-batch" - `attributes` (object, required) - `attributes.audienceId` (string, required) - `attributes.name` (string, required) - `attributes.description` (string,null, required) - `attributes.population` (number,null, required) - `attributes.numSyndications` (integer) - `attributes.rule` (any, required) - `conditions` (array, required) - `conditions` (array, required) - `arrayMatching` (any, required) — one of: - variant 3: - `atLeast` (number, required) - variant 4: - `atMost` (number, required) - variant 5: - `exactly` (number, required) - `exclude` (boolean, required) - `leftValue` (any, required) — one of: - partial_v5_rule.yaml-v5IonRule-attributeNameValue: - `name` (string, required) - partial_v5_rule.yaml-v5IonRule-customerGroupAttributeValue: - `customerGroup` (string, required) - `name` (string, required) - partial_v5_rule.yaml-v5IonRule-aggregationValue: - `aggregation` (any, required) — one of: - variant 1: - `column` (string, required) - `groupingColumns` (array) - `type` (string, required) Enum: same as `type` in "variant 1" (4 values) - variant 2: - `groupingColumns` (array, required) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - variant 3: - `columns` (array, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 4: - `column` (string, required) - `groupingColumns` (array) - `orderColumn` (string, required) - `type` (string, required) Enum: same as `type` in "variant 4" (2 values) - `filter` (any, required) — one of: - partial_v5_rule.yaml-v5IonRule-andFilter: - `conditions` (array, required) - `conditions` (array, required) - `type` (string, required) Enum: same as `type` (1 values) - `type` (string, required) Enum: same as `type` in "partial_v5_rule.yaml-v5IonRule-andFilter" (1 values) - partial_v5_rule.yaml-v5IonRule-orFilter: - `conditions` (array, required) - `conditions` (array, required) - `type` (string, required) Enum: same as `type` in "partial_v5_rule.yaml-v5IonRule-andFilter" (1 values) - `type` (string, required) Enum: same as `type` (1 values) - `source` (object, required) - `source.name` (string, required) - `window` (object) - `window.duration` (object, required) - `window.duration.day` (number) - `window.duration.hour` (number) - `window.duration.minute` (number) - `window.duration.second` (number) - `window.type` (string, required) Enum: same as `window.type` in "partial_v5_rule.yaml-v5IonRule-aggregationValue" (1 values) - `limit` (object) - `limit.number` (number, required) - `limit.orderColumns` (array) — one of: - variant 1: - `column` (string, required) - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 2: - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - `limit.type` (string, required) Enum: same as `limit.type` (2 values) - `operator` (any, required) — one of: - variant 1: - `not` (boolean, required) - `rightValue` (object, required) - `rightValue.last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `rightValue.unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 3: - `not` (boolean, required) - `rightValue` (object, required) - `rightValue.timestamp` (string, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 4: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 4" (1 values) - variant 5: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (object, required) - `rightValue.timestamp` (string, required) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 6: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 6" (1 values) - variant 7: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 7" (1 values) - variant 8: - `maxValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `minValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `not` (boolean, required) - `type` (string, required) Enum: same as `type` in "variant 8" (1 values) - variant 9: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 10: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 10" (1 values) - variant 11: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 11" (1 values) - variant 12: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 4" (1 values) - variant 13: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 6" (1 values) - variant 14: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 15: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 7" (1 values) - variant 16: - `maxValue` (any, required) - `minValue` (any, required) - `not` (boolean, required) - `rightValue` (number, required) - `type` (string, required) Enum: same as `type` in "variant 8" (1 values) - variant 17: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 17" (1 values) - variant 18: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 18" (1 values) - variant 19: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 19" (1 values) - variant 20: - `not` (boolean, required) - `rightValue` (string, required) - `type` (string, required) Enum: same as `type` in "variant 20" (1 values) - `type` (string, required) Enum: same as `type` (1 values) - `description` (string) - `expr` (string) - `type` (string, required) Enum: same as `type` (3 values) - `expr` (string) - `limit` (object) - `limit.number` (number, required) - `limit.orderColumns` (array) — one of: - variant 1: - `column` (string, required) - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 2: - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - `limit.type` (string, required) Enum: same as `limit.type` (2 values) - `type` (string, required) Enum: same as `type` (3 values) - `attributes.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.countPopulation` (boolean) - `attributes.segmentInsightDashboardId` (integer,null) - `attributes.isEmptyRule` (boolean) - `relationships` (object, required) - `relationships.parentFolder` (object) - `relationships.createdBy` (object) - `relationships.createdBy.data` (object,null) - `relationships.createdBy.data.id` (string, required) - `relationships.createdBy.data.type` (string, required) Enum: "user" - `relationships.updatedBy` (object) - RealtimeSegmentJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "segment-realtime" - `attributes` (object, required) - `attributes.audienceId` (string, required) - `attributes.name` (string, required) - `attributes.description` (string,null, required) - `attributes.population` (number,null, required) - `attributes.numSyndications` (integer,null) - `attributes.rule` (any, required) - `conditions` (array, required) - `conditions` (array, required) - `arrayMatching` (any, required) — one of: - variant 3: - `atLeast` (number, required) - variant 4: - `atMost` (number, required) - variant 5: - `exactly` (number, required) - `exclude` (boolean, required) - `leftValue` (any, required) — one of: - partial_v5_rule.yaml-v5IonRule-attributeNameValue: - `name` (string, required) - partial_v5_rule.yaml-v5IonRule-customerGroupAttributeValue: - `customerGroup` (string, required) - `name` (string, required) - partial_v5_rule.yaml-v5IonRule-aggregationValue: - `aggregation` (any, required) — one of: - variant 1: - `column` (string, required) - `groupingColumns` (array) - `type` (string, required) Enum: same as `type` in "variant 1" (4 values) - variant 2: - `groupingColumns` (array, required) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - variant 3: - `columns` (array, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 4: - `column` (string, required) - `groupingColumns` (array) - `orderColumn` (string, required) - `type` (string, required) Enum: same as `type` in "variant 4" (2 values) - `filter` (any, required) — one of: - partial_v5_rule.yaml-v5IonRule-andFilter: - `conditions` (array, required) - `conditions` (array, required) - `type` (string, required) Enum: same as `type` (1 values) - `type` (string, required) Enum: same as `type` in "partial_v5_rule.yaml-v5IonRule-andFilter" (1 values) - partial_v5_rule.yaml-v5IonRule-orFilter: - `conditions` (array, required) - `conditions` (array, required) - `type` (string, required) Enum: same as `type` in "partial_v5_rule.yaml-v5IonRule-andFilter" (1 values) - `type` (string, required) Enum: same as `type` (1 values) - `source` (object, required) - `source.name` (string, required) - `window` (object) - `window.duration` (object, required) - `window.duration.day` (number) - `window.duration.hour` (number) - `window.duration.minute` (number) - `window.duration.second` (number) - `window.type` (string, required) Enum: same as `window.type` in "partial_v5_rule.yaml-v5IonRule-aggregationValue" (1 values) - `limit` (object) - `limit.number` (number, required) - `limit.orderColumns` (array) — one of: - variant 1: - `column` (string, required) - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 2: - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - `limit.type` (string, required) Enum: same as `limit.type` (2 values) - `operator` (any, required) — one of: - variant 1: - `not` (boolean, required) - `rightValue` (object, required) - `rightValue.last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `rightValue.unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 3: - `not` (boolean, required) - `rightValue` (object, required) - `rightValue.timestamp` (string, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 4: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 4" (1 values) - variant 5: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (object, required) - `rightValue.timestamp` (string, required) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 6: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 6" (1 values) - variant 7: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 7" (1 values) - variant 8: - `maxValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `minValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `not` (boolean, required) - `type` (string, required) Enum: same as `type` in "variant 8" (1 values) - variant 9: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 10: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 10" (1 values) - variant 11: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 11" (1 values) - variant 12: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 4" (1 values) - variant 13: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 6" (1 values) - variant 14: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 15: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 7" (1 values) - variant 16: - `maxValue` (any, required) - `minValue` (any, required) - `not` (boolean, required) - `rightValue` (number, required) - `type` (string, required) Enum: same as `type` in "variant 8" (1 values) - variant 17: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 17" (1 values) - variant 18: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 18" (1 values) - variant 19: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 19" (1 values) - variant 20: - `not` (boolean, required) - `rightValue` (string, required) - `type` (string, required) Enum: same as `type` in "variant 20" (1 values) - `type` (string, required) Enum: same as `type` (1 values) - `description` (string) - `expr` (string) - `type` (string, required) Enum: same as `type` (3 values) - `expr` (string) - `limit` (object) - `limit.number` (number, required) - `limit.orderColumns` (array) — one of: - variant 1: - `column` (string, required) - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 2: - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - `limit.type` (string, required) Enum: same as `limit.type` (2 values) - `type` (string, required) Enum: same as `type` (3 values) - `attributes.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.countPopulation` (boolean) - `relationships` (object, required) - `relationships.parentFolder` (object) - `relationships.createdBy` (object) - `relationships.createdBy.data` (object,null) - `relationships.createdBy.data.id` (string, required) - `relationships.createdBy.data.type` (string, required) Enum: same as `relationships.createdBy.data.type` in "BatchSegmentJsonApiResource" (1 values) - `relationships.updatedBy` (object) - FunnelStageSegmentJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "segment-funnel-stage" - `attributes` (object, required) - `attributes.audienceId` (string, required) - `attributes.name` (string, required) - `attributes.description` (string,null, required) - `attributes.population` (number,null, required) - `attributes.numSyndications` (integer) - `attributes.rule` (any, required) - `conditions` (array, required) - `conditions` (array, required) - `arrayMatching` (any, required) — one of: - variant 3: - `atLeast` (number, required) - variant 4: - `atMost` (number, required) - variant 5: - `exactly` (number, required) - `exclude` (boolean, required) - `leftValue` (any, required) — one of: - partial_v5_rule.yaml-v5IonRule-attributeNameValue: - `name` (string, required) - partial_v5_rule.yaml-v5IonRule-customerGroupAttributeValue: - `customerGroup` (string, required) - `name` (string, required) - partial_v5_rule.yaml-v5IonRule-aggregationValue: - `aggregation` (any, required) — one of: - variant 1: - `column` (string, required) - `groupingColumns` (array) - `type` (string, required) Enum: same as `type` in "variant 1" (4 values) - variant 2: - `groupingColumns` (array, required) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - variant 3: - `columns` (array, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 4: - `column` (string, required) - `groupingColumns` (array) - `orderColumn` (string, required) - `type` (string, required) Enum: same as `type` in "variant 4" (2 values) - `filter` (any, required) — one of: - partial_v5_rule.yaml-v5IonRule-andFilter: - `conditions` (array, required) - `conditions` (array, required) - `type` (string, required) Enum: same as `type` (1 values) - `type` (string, required) Enum: same as `type` in "partial_v5_rule.yaml-v5IonRule-andFilter" (1 values) - partial_v5_rule.yaml-v5IonRule-orFilter: - `conditions` (array, required) - `conditions` (array, required) - `type` (string, required) Enum: same as `type` in "partial_v5_rule.yaml-v5IonRule-andFilter" (1 values) - `type` (string, required) Enum: same as `type` (1 values) - `source` (object, required) - `source.name` (string, required) - `window` (object) - `window.duration` (object, required) - `window.duration.day` (number) - `window.duration.hour` (number) - `window.duration.minute` (number) - `window.duration.second` (number) - `window.type` (string, required) Enum: same as `window.type` in "partial_v5_rule.yaml-v5IonRule-aggregationValue" (1 values) - `limit` (object) - `limit.number` (number, required) - `limit.orderColumns` (array) — one of: - variant 1: - `column` (string, required) - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 2: - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - `limit.type` (string, required) Enum: same as `limit.type` (2 values) - `operator` (any, required) — one of: - variant 1: - `not` (boolean, required) - `rightValue` (object, required) - `rightValue.last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `rightValue.unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 3: - `not` (boolean, required) - `rightValue` (object, required) - `rightValue.timestamp` (string, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 4: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 4" (1 values) - variant 5: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (object, required) - `rightValue.timestamp` (string, required) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 6: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 6" (1 values) - variant 7: - `not` (boolean, required) Enum: same as `not` in "variant 4" (1 values) - `rightValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `type` (string, required) Enum: same as `type` in "variant 7" (1 values) - variant 8: - `maxValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `minValue` (any, required) — one of: - variant 1: - `timestamp` (string, required) - variant 2: - `last` (any, required) - `day` (number) - `hour` (number) - `minute` (number) - `month` (number) - `quarter` (number) - `second` (number) - `week` (number) - `year` (number) - `unit` (string, required) Enum: same as `rightValue.unit` in "variant 1" (8 values) - `not` (boolean, required) - `type` (string, required) Enum: same as `type` in "variant 8" (1 values) - variant 9: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 3" (1 values) - variant 10: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 10" (1 values) - variant 11: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 11" (1 values) - variant 12: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 4" (1 values) - variant 13: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 6" (1 values) - variant 14: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 15: - `not` (boolean, required) - `rightValue` (any, required) - `type` (string, required) Enum: same as `type` in "variant 7" (1 values) - variant 16: - `maxValue` (any, required) - `minValue` (any, required) - `not` (boolean, required) - `rightValue` (number, required) - `type` (string, required) Enum: same as `type` in "variant 8" (1 values) - variant 17: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 17" (1 values) - variant 18: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 18" (1 values) - variant 19: - `not` (boolean, required) - `rightValues` (array, required) - `type` (string, required) Enum: same as `type` in "variant 19" (1 values) - variant 20: - `not` (boolean, required) - `rightValue` (string, required) - `type` (string, required) Enum: same as `type` in "variant 20" (1 values) - `type` (string, required) Enum: same as `type` (1 values) - `description` (string) - `expr` (string) - `type` (string, required) Enum: same as `type` (3 values) - `expr` (string) - `limit` (object) - `limit.number` (number, required) - `limit.orderColumns` (array) — one of: - variant 1: - `column` (string, required) - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 1" (1 values) - variant 2: - `order` (string, required) Enum: same as `order` in "variant 1" (2 values) - `type` (string, required) Enum: same as `type` in "variant 2" (1 values) - `limit.type` (string, required) Enum: same as `limit.type` (2 values) - `type` (string, required) Enum: same as `type` (3 values) - `attributes.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.countPopulation` (boolean) - `relationships` (object, required) - `relationships.parentFolder` (object) - `relationships.createdBy` (object) - `relationships.createdBy.data` (object,null) - `relationships.createdBy.data.id` (string, required) - `relationships.createdBy.data.type` (string, required) Enum: same as `relationships.createdBy.data.type` in "BatchSegmentJsonApiResource" (1 values) - `relationships.updatedBy` (object) - `included` (array, required) - `included.id` (string, required) - `included.type` (string, required) Enum: same as `relationships.createdBy.data.type` in "BatchSegmentJsonApiResource" (1 values) - `included.attributes` (object, required) - `included.attributes.tdUserId` (string, required) - `included.attributes.name` (string, required)