# Retrieve list of objects under specified folder Retrieve a list of objects under a specified folder, including child folders, segments, batch segments, predictive scoring models, funnels, Profile API tokens and Journeys. Endpoint: GET /entities/by-folder/{folderId} Version: 1.0.0 Security: TdApikeyAuth ## Path parameters: - `folderId` (integer, required) Segment Folder ID ## Query parameters: - `depth` (integer, required) Depth of retrieved folders - `with_rule` (boolean) Set false to ignore the segment rule ## Response 200 fields (application/json): - `data` (array, required) — one of: - FolderJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "folder-segment" - `attributes` (object, required) - `attributes.audienceId` (string, required) ID of the parent audience. For composable folders this carries the composable audience id; the complete-vs-composable discriminator lives on the parent audience entity, not on the folder. - `attributes.name` (string, required) - `attributes.description` (string,null, required) - `attributes.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.enrichments` (object,null) - `attributes.rule` (object,null) - `attributes.permissions` (object, required) - `attributes.permissions.view` (boolean) - `attributes.permissions.edit` (boolean) - `relationships` (object, required) - `relationships.children` (object) - `relationships.children.data` (array) - `relationships.children.data.data` (object) - `relationships.children.data.data.id` (string, required) - `relationships.children.data.data.type` (string, required) Enum: "folder-segment", "segment-batch", "segment-realtime", "composable-segment", "funnel", "predictive-segment", "token", "journey" - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object,null) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `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) - 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: "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.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.countPopulation` (boolean) - `attributes.segmentInsightDashboardId` (integer,null) - `attributes.isEmptyRule` (boolean) - `relationships` (object, required) - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `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 "FolderJsonApiResource" (1 values) - `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.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `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 "FolderJsonApiResource" (1 values) - `relationships.updatedBy` (object) - ComposableSegmentJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "composable-segment" - `attributes` (object, required) - `attributes.composableAudienceId` (string, required) ID of the composable audience this segment belongs to - `attributes.name` (string, required) Name of the composable segment - `attributes.description` (string,null, required) Description of the composable segment - `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.isEmptyRule` (boolean, required) Indicates whether the segment has an empty rule (no filtering criteria) - `attributes.population` (number,null, required) Population count for the segment. Currently always null for composable segments as population tracking is not yet implemented - `attributes.numSyndications` (integer, required) Number of activations (syndications) associated with this segment - `attributes.createdAt` (string, required) Timestamp when the segment was created - `attributes.updatedAt` (string, required) Timestamp when the segment was last updated - `relationships` (object, required) - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `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 "FolderJsonApiResource" (1 values) - `relationships.updatedBy` (object) - FunnelJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "funnel" - `attributes` (object, required) - `attributes.audienceId` (string, required) - `attributes.name` (string, required) - `attributes.description` (string,null, required) - `attributes.population` (number,null, required) - `attributes.numSyndications` (integer, required) - `attributes.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.countPopulation` (boolean) - `attributes.stages` (array) - `attributes.stages.id` (string) - `attributes.stages.segmentId` (string) - `attributes.stages.name` (string, required) - `attributes.stages.numSyndications` (integer) - `relationships` (object, required) - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `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 "FolderJsonApiResource" (1 values) - `relationships.updatedBy` (object) - PredictiveSegmentJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "predictive-segment" - `attributes` (object, required) - `attributes.audienceId` (string) - `attributes.baseSegmentId` (string,null) - `attributes.segmentId` (string) - `attributes.scoredSegmentId` (string,null) - `attributes.name` (string) - `attributes.description` (string,null) - `attributes.categoricalAsColumnNames` (array) - `attributes.categoricalArrayAsColumnNames` (array) - `attributes.quantitativeAsColumnNames` (array) - `attributes.accuracy` (number,null) Accuracy for trained model evaluated on initial training. - `attributes.areaUnderRocCurve` (number,null) Evaluation score for the model. See also https://en.wikipedia.org/wiki/Receiver_operating_characteristic#Area_under_the_curve - `attributes.gradeThresholds` (array) Given the items [a, b, c], they must meet the condition a >= b >= c Example: [75,50,25] - `attributes.createdAt` (string) - `attributes.updatedAt` (string) - `attributes.modelUpdatedAt` (string) - `relationships` (object, required) - `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 "FolderJsonApiResource" (1 values) - `relationships.updatedBy` (object) - TokenJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "token" - `attributes` (object, required) - `attributes.audienceId` (string) - `attributes.name` (string, required) - `attributes.token` (string) UUID of the token - `attributes.description` (string) - `attributes.keyColumn` (string) A key column name to fetch the information of a customer. Example: "td_client_id" - `attributes.attributeColumns` (array, required) associated attribute column names. Example: ["gender","country"] - `attributes.createdAt` (string) - `attributes.updatedAt` (string) - `relationships` (object, required) - `relationships.segments` (object) - `relationships.segments.data` (array) — one of: - RelationshipsBatchSegmentJsonApiResource: - `data` (object) - `data.id` (string, required) - `data.type` (string, required) Enum: same as `type` in "BatchSegmentJsonApiResource" (1 values) - RelationshipsRealtimeSegmentJsonApiResource: - `data` (object) - `data.id` (string, required) - `data.type` (string, required) Enum: same as `type` in "RealtimeSegmentJsonApiResource" (1 values) - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `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 "FolderJsonApiResource" (1 values) - `relationships.updatedBy` (object) - JourneyJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "journey" - `attributes` (object, required) - `attributes.audienceId` (string, required) - `attributes.name` (string, required) - `attributes.description` (string,null, required) - `attributes.state` (string, required) Enum: "draft", "simulation", "launched" - `attributes.goal` (object,null, required) - `attributes.goal.name` (string, required) - `attributes.goal.description` (string) - `attributes.goal.segmentId` (string, required) - `attributes.goal.target` (object) - `attributes.goal.target.journeyId` (string, required) - `attributes.goal.target.journeyStageId` (string, required) - `attributes.goal.target.journeyBundleId` (string,null) - `attributes.goal.target.stageOrderIndex` (integer,null) - `attributes.goal.target.jumpReferenceId` (string,null) The reference id of the jump target. This is used to identify the jump entity in the included field. - `attributes.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.journeyStages` (array, required) - `attributes.journeyStages.id` (string) - `attributes.journeyStages.name` (string, required) - `attributes.journeyStages.description` (string) - `attributes.journeyStages.steps` (object,null) - `attributes.journeyStages.steps.uuid` (any) — one of: - JourneyActivationStep: - `type` (any, required) Enum: "Activation" - `name` (string, required) - `journeyActivationStepId` (string, required) - `next` (string) - JourneyDecisionPointStep: - `type` (any, required) Enum: "DecisionPoint" - `name` (string, required) - `branches` (array, required) - `branches.name` (string, required) - `branches.segmentId` (string, required) - `branches.excludedPath` (boolean) - `branches.next` (string) - JourneyMergeStep: - `type` (any, required) Enum: "Merge" - `name` (string) - `next` (string) - JourneyJumpStep: - `type` (any, required) Enum: "Jump" - `name` (string, required) - `target` (object, required) - JourneyEndStep: - `type` (any) Enum: "End" - `name` (string) - JourneyAbTestStep: - `type` (any, required) Enum: "AbTest" - `name` (string, required) - `customizedSplit` (boolean, required) - `uniqueId` (string) - `variants` (array, required) - `variants.id` (string, required) - `variants.name` (string, required) - `variants.percentage` (number, required) - `variants.next` (string) - `attributes.journeyStages.rootStep` (string) - `attributes.journeyStages.entryCriteria` (object,null) - `attributes.journeyStages.milestone` (object,null) - `attributes.journeyStages.exitCriterias` (array) - `attributes.paused` (boolean, required) - `attributes.pausedAt` (string,null, required) - `attributes.allowReentry` (boolean, required) - `attributes.reentryMode` (string) Enum: "no_reentry", "reentry_unless_goal_achieved", "reentry_always" - `attributes.journeyBundleId` (string,null) - `attributes.journeyBundleName` (string,null) - `attributes.versionNumber` (integer) - `attributes.journeyBundleDescription` (string,null) - `attributes.latestExecution` (object,null) The most recent execution of the journey workflow. If no executions have been created, this will be null. - `attributes.latestExecution.workflowId` (string, required) - `attributes.latestExecution.workflowSessionId` (string, required) - `attributes.latestExecution.createdAt` (string, required) - `attributes.latestExecution.finishedAt` (string,null, required) - `attributes.latestExecution.status` (string, required) Enum: "success", "canceled", "error", "canceling", "blocked", "queued", "running" - `attributes.latestExecution.workflowAttemptId` (string, required) - `relationships` (object, required) - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `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 "FolderJsonApiResource" (1 values) - `relationships.updatedBy` (object) - ActivationTemplateJsonApiResource: - `id` (string) - `type` (string) Enum: "activation-template" - `attributes` (object) - `attributes.audienceId` (string, required) - `attributes.name` (string, required) - `attributes.description` (string,null, required) - `attributes.kind` (integer) 0: batch, 1: batch_journey - `attributes.allColumns` (boolean) activation all column flag ('true' means that you use all attribute data) - `attributes.columns` (any) — one of: - Columns: - `id` (string) - `column` (string, required) - `source` (any, required) — one of: - ColumnExpression: - `column` (string, required) - `customerGroup` (string,null) - `functions` (array,null) — one of: - variant 1: - `function` (string, required) Enum: "+", "-", "*", "/" - `arg` (number) - variant 2: - `function` (string, required) Enum: "replace" - `search` (string) - `replacement` (string,null) - variant 3: - `function` (string, required) Enum: "substr" - `start` (number) - `length` (number) - variant 4: - `function` (string, required) Enum: "regexp_extract" - `pattern` (string) - `group` (number) - variant 5: - `function` (string, required) Enum: "day_of_week", "from_iso8601_timestamp", "ln", "elapsed_days", "td_ip_to_least_specific_subdivision_name", "td_ip_to_country_name", "td_ip_to_city_name", "td_ip_to_connection_type", "td_ip_to_domain" - variant 6: - `function` (string, required) Enum: "cast_as_quantitative" - `default` (number, required) - variant 7: - `function` (string, required) Enum: "cast_as_categorical" - `default` (string, required) - variant 8: - `function` (string, required) Enum: "cast_as_categorical_array" - variant 9: - `function` (string, required) Enum: "if" - `op` (string) Enum: ">", "<", "<=", ">=", "=", "!=", "is", "is\\", "not" - `right_value` (number,null) - `then` (number) - `else` (number) - StringExpression: - `string` (string, required) - `parameters` (array) — one of: Values for the placeholders ($1, $2, $3, ...) in the string - variant 1: - `type` (string) Enum: "String" - `string` (string) - variant 2: - `type` (string) Enum: "Timestamp" - `format` (string) - variant 3: - `type` (string) Enum: "SegmentName", "SegmentId", "AudienceId", "FunnelName", "StageName" - NullValue: - `thisKeyNeverHit` (string) - `attributes.scheduleOption` (string,null) - `attributes.timezone` (string,null) - `attributes.startAt` (string,null) cdp-api will fill some value for old syndications with ScheduleType is not NoneType. '%Y-%M-%DT%h:%m:%s' is expected. - `attributes.endOn` (string,null) - `attributes.repeatUnit` (string) Setting an activation repetition cycle such as "day" or "week". Enum: "none", "minute", "hour", "day", "week", "month", "once" - `attributes.repeatFrequency` (integer) Setting an activation repeat frequency. Currently, it is set only when the repeat unit is "minute". If the repeat unit is "minute", the interval is set in minutes. - `attributes.repeatSubFrequency` (array) Parameter for more detailed frequency settings. Values are array of integers. Currently, this parameter is only valid for repeat unit "week". For multiple days of the week, each value should be 1 to 7. 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday Example: [1,5,6] - `attributes.connectionId` (string,null) - `attributes.connectorConfig` (object,null) - `attributes.notifyOn` (array) Enum: "onSuccess", "onFailure" - `attributes.emailRecipients` (array) - `attributes.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.state` (string) Enum: "draft", "published" - `attributes.nestedWorkflowProjectName` (string,null) - `attributes.nestedWorkflowName` (string,null) - `attributes.activationActionsEnabled` (boolean) - `attributes.lockEnabled` (boolean) - `attributes.runAfterJourneyRefresh` (boolean,null) If true, this activation step will be executed immediately after the journey is refreshed. Only available for kind of journey. - `attributes.syndicationBehavior` (object,null) - `attributes.syndicationBehavior.columns` (array) Syndication column detail. Basic syntax is {"column": "alias_name", "source": {...}}. source accepts various definitions. See ColumnExpression/StringExpression for details. example value is using ColumnExpression without function property. Example: [{"column":"alias_name","source":{"column":"real_column_name"}}] - `attributes.syndicationBehavior.columns.id` (string) - `attributes.syndicationBehavior.columns.column` (string, required) - `attributes.syndicationBehavior.columns.source` (any, required) — one of: - ColumnExpression: - `column` (string, required) - `customerGroup` (string,null) - `functions` (array,null) — one of: - variant 1: - `function` (string, required) Enum: same as `function` in "variant 1" (4 values) - `arg` (number) - variant 2: - `function` (string, required) Enum: same as `function` in "variant 2" (1 values) - `search` (string) - `replacement` (string,null) - variant 3: - `function` (string, required) Enum: same as `function` in "variant 3" (1 values) - `start` (number) - `length` (number) - variant 4: - `function` (string, required) Enum: same as `function` in "variant 4" (1 values) - `pattern` (string) - `group` (number) - variant 5: - `function` (string, required) Enum: same as `function` in "variant 5" (9 values) - variant 6: - `function` (string, required) Enum: same as `function` in "variant 6" (1 values) - `default` (number, required) - variant 7: - `function` (string, required) Enum: same as `function` in "variant 7" (1 values) - `default` (string, required) - variant 8: - `function` (string, required) Enum: same as `function` in "variant 8" (1 values) - variant 9: - `function` (string, required) Enum: same as `function` in "variant 9" (1 values) - `op` (string) Enum: same as `op` in "variant 9" (9 values) - `right_value` (number,null) - `then` (number) - `else` (number) - StringExpression: - `string` (string, required) - `parameters` (array) — one of: Values for the placeholders ($1, $2, $3, ...) in the string - variant 1: - `type` (string) Enum: same as `type` in "variant 1" (1 values) - `string` (string) - variant 2: - `type` (string) Enum: same as `type` in "variant 2" (1 values) - `format` (string) - variant 3: - `type` (string) Enum: same as `type` in "variant 3" (5 values) - `attributes.syndicationBehavior.behaviorTableName` (string) Behavior table name which contains behavior records Example: "purchase_history" - `attributes.syndicationBehavior.joinRow` (integer,null) How much rows would be joined (value is N for Top-N join) Example: 3 - `attributes.syndicationBehavior.joinStrategy` (string) Enum: "All", "First", "Last", "Top-N" - `attributes.syndicationBehavior.formatting` (string) Enum: "rows", "cols" - `attributes.syndicationBehavior.orderBy` (array) Example: [{"key":"purchased_at","order":"descending"},{"key":"price","order":"ascending"}] - `attributes.syndicationBehavior.orderBy.key` (string) Example: "purchased_at" - `attributes.syndicationBehavior.orderBy.order` (string) Enum: same as `order` in "variant 1" (2 values) - `attributes.fieldProperties` (object) activation template field properties - `attributes.fieldProperties.locked` (object, required) activation template field properties locked - `attributes.fieldProperties.locked.allColumns` (boolean) - `attributes.fieldProperties.locked.columns` (object) Example: {"b24bf298-4f8c-4e8a-8187-38f2efc781d9":{"column":true,"source":true,"lockDeleteColumn":false},"c97c5711-31dd-4563-aca9-795c0b429593":{"column":true,"source":true,"lockDeleteColumn":false}} - `attributes.fieldProperties.locked.connectionId` (boolean) - `attributes.fieldProperties.locked.connectorConfig` (object,null) Example: {"userDatabaseName":true,"userTableName":true,"legacy":false,"mode":false} - `attributes.fieldProperties.locked.activationActionsEnabled` (boolean) - `attributes.fieldProperties.locked.syndicationBehavior` (object,null) - `attributes.fieldProperties.locked.syndicationBehavior.tableName` (string) Behavior table name which contains behavior records Example: "purchase_history" - `attributes.fieldProperties.locked.syndicationBehavior.columns` (object) Example: {"0ae6e876-9d9d-4217-8be2-f8646000d0c2":{"column":true,"source":true,"lockDeleteColumn":false},"b71d422e-4f29-47d5-b072-7e598275a402":{"column":true,"source":true,"lockDeleteColumn":false}} - `attributes.fieldProperties.locked.syndicationBehavior.lockAddColumn` (boolean) - `attributes.fieldProperties.locked.syndicationBehavior.lockDeleteBehaviorTable` (boolean) - `attributes.fieldProperties.locked.syndicationBehavior.lockEditBehaviorTable` (boolean) - `attributes.fieldProperties.locked.syndicationBehavior.lockEditJoinRow` (boolean) - `attributes.fieldProperties.locked.syndicationBehavior.lockEditJoinStrategy` (boolean) - `attributes.fieldProperties.locked.syndicationBehavior.lockEditFormatting` (boolean) - `attributes.fieldProperties.locked.syndicationBehavior.lockEditOrderBy` (boolean) - `attributes.fieldProperties.locked.lockAddColumn` (boolean) - `attributes.fieldProperties.locked.lockAddString` (boolean) - `attributes.fieldProperties.locked.lockAddBehavior` (boolean) - `attributes.fieldProperties.locked.lockEditSchedule` (boolean) - `attributes.fieldProperties.locked.lockEditNotification` (boolean) - `attributes.fieldProperties.locked.lockEditWorkflowExecution` (boolean) - `attributes.fieldProperties.locked.lockEditSequentialActivation` (boolean) - `attributes.activationCount` (integer) Number of related activations - `attributes.journeyCount` (integer) Number of related journeys - `attributes.available` (boolean) This template is available or not (It contains PBP PII BLOCKED columns or not) - `attributes.scheduleType` (string) Deprecated. Old parameter for setting schedule type. See/Use RepeatUnit instead. Enum: "cron", "daily", "hourly", "minutes_interval", "monthly", "none", "weekly" - `relationships` (object) - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `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 "FolderJsonApiResource" (1 values) - `relationships.updatedBy` (object) - partial_realtime_journey.yaml-RealtimeJourneyByFolderResource: - `id` (string) - `type` (string) Enum: "realtime-journey" - `attributes` (object) - `attributes.name` (string, required) - `attributes.description` (string, required) - `attributes.state` (string, required) Enum: "draft", "launched" - `attributes.paused` (boolean, required) - `attributes.realtimeJourneyStages` (array, required) - `attributes.realtimeJourneyStages.id` (string) - `attributes.realtimeJourneyStages.name` (string, required) - `relationships` (object) - `relationships.parentFolder` (object, required) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - partial_realtime_journey.yaml-RealtimePersonalizationByFolderResource: - `id` (string) - `type` (string) Enum: "realtime-personalization" - `attributes` (object) - `attributes.name` (string, required) - `attributes.description` (string, required) - `attributes.sections` (array, required) - `attributes.sections.id` (string) - `attributes.sections.name` (string, required) - `relationships` (object) - `relationships.parentFolder` (object, required) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - MlSolutionJsonApiResource: - `id` (string, required) - `type` (string, required) Enum: "mlSolution" - `attributes` (object, required) — one of: - variant 1: - `name` (string, required) - `audienceId` (string, required) - `description` (string,null, required) - `targetColumn` (string, required) Target column name for the prediction - `state` (string, required) Enum: same as `attributes.state` in "ActivationTemplateJsonApiResource" (2 values) - `solutionType` (string, required) Enum: "rfm" - `behaviorName` (string, required) Behavior name for input data - `timestampColumn` (string) Timestamp column name for input data. If not specified, the column will be generated by time - `minClusters` (integer,null) - `maxClusters` (integer,null) - `numClusters` (integer,null) - variant 2: - `name` (string, required) - `audienceId` (string, required) - `description` (string,null, required) - `targetColumn` (string, required) Target column name for the prediction - `state` (string, required) Enum: same as `attributes.state` in "ActivationTemplateJsonApiResource" (2 values) - `solutionType` (string, required) Enum: "cltv" - `behaviorName` (string, required) Behavior name for input data - `timestampColumn` (string) Timestamp column name for input data. If not specified, the column will be generated by time - `discountRate` (number,null) - `segmentTimeHorizon` (string,null) Time horizon for CLTV segments in 1m/3m/6m/12m/24m Example: "12m" - `attributes.createdAt` (string, required) - `attributes.updatedAt` (string, required) - `attributes.lastPublishedAt` (string,null, required) Last published date time. If null, it means the solution is not published yet. - `relationships` (object, required) - `relationships.parentFolder` (object) - `relationships.parentFolder.data` (object) - `relationships.parentFolder.data.id` (string, required) - `relationships.parentFolder.data.type` (string, required) Enum: same as `type` in "FolderJsonApiResource" (1 values) - `relationships.outputFolder` (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 "FolderJsonApiResource" (1 values) - `relationships.updatedBy` (object) - `included` (array, required) - `included.id` (string, required) - `included.type` (string, required) Enum: same as `relationships.createdBy.data.type` in "FolderJsonApiResource" (1 values) - `included.attributes` (object, required) - `included.attributes.tdUserId` (string, required) - `included.attributes.name` (string, required)