{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"redocly_category":"Treasure Code","product_name":"Treasure Code","type":"markdown"},"seo":{"title":"tdx journey - Journey Orchestration | Treasure Data","description":"Manage CDP Journey Orchestration with YAML files. Create and automate customer journeys with tdx.","siteUrl":"https://docs.treasuredata.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]},"image":"/assets/og-image.ba836864a30434f560a4f7720f8a09019ad30ff828b20c5052ae933ba7121524.d7ef4821.png"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"journey-commands","__idx":0},"children":["Journey Commands"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage CDP Journey Orchestration for customer journey automation."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Premium Feature"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Journey Orchestration is a premium feature. Contact your Customer Success Representative for more information."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Journey Orchestration enables marketers to create automated customer journeys that guide customers through stages based on their behavior and attributes. Journeys differ from segments in that they track individual profile progression through defined stages over time."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-concepts","__idx":2},"children":["Key Concepts"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Journey"]},": A timeline of stages that customers progress through toward a goal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Stage"]},": A step in the journey with entry criteria, exit criteria, and actions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step"]},": An action or decision within a stage (wait, activation, decision point, A/B test)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Goal"]},": The desired outcome that marks journey completion"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reentry"]},": Rules for whether profiles can re-enter the journey"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commands","__idx":3},"children":["Commands"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Command"},"children":["Command"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#list"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List journeys in current context"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#view"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["view"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show journey details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#pull"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pull"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pull journey configuration to YAML"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#push"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Push YAML configuration to TD"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#validate"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validate"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Validate journey YAML files locally"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#run"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["run"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Trigger on-demand journey workflow execution"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#pause"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pause"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pause a running journey"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#resume"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resume"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Resume a paused journey"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#stats"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stats"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show journey statistics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#traffic"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["traffic"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get journey traffic data (Sankey charts)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#columns"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["columns"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show journey table column mapping"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#activations"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["activations"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List activations for a journey"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#versions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["versions"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List all versions of a journey"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#version-create"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version create"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a new draft version of a journey"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#version-view"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version view"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View a specific version of a journey"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typical-workflow","__idx":4},"children":["Typical Workflow"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# 1. Pull segments from a parent segment\ntdx sg pull \"My Audience\"\n# Creates: segments/my-audience/*.yml\n\n# 2. Pull journeys (stored alongside segments)\ntdx journey pull\n# Creates: segments/my-audience/*.yml (journey files have type: journey)\n\n# 3. Edit YAML files locally\n# Edit segments/my-audience/onboarding-journey.yml\n\n# 4. Push changes (preview first with --dry-run)\ntdx journey push --dry-run   # Preview journey-only changes\ntdx journey push             # Push journey-only changes\n# Or push everything (segments, journeys, activations):\ntdx sg push --dry-run\ntdx sg push\n\n# 5. Monitor journey statistics\ntdx journey stats \"Onboarding Journey\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"yaml-format","__idx":5},"children":["YAML Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Journeys are stored alongside segments in the parent segment folder:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"segments/\n└── my-audience/\n    ├── tdx.json                       # Parent segment context\n    ├── high-value-customers.yml       # Segment\n    ├── new-signups.yml                # Segment\n    ├── onboarding-journey.yml         # Journey\n    └── retention-campaign.yml         # Journey\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"journey-yaml-schema","__idx":6},"children":["Journey YAML Schema"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# segments/my-audience/onboarding-journey.yml\ntype: journey\nname: Onboarding Journey\ndescription: New customer onboarding flow\n\n# Goal criteria - when is the journey complete?\ngoal:\n  name: Completed Onboarding\n  segment: entry-customers  # Reference to embedded segment\n\n# Reentry rules\nreentry: no_reentry  # no_reentry | reentry_unless_goal_achieved | reentry_always\n\n# Embedded segments - journey-local segment definitions\n# These segments are created/managed with the journey\nsegments:\n  entry-customers:\n    description: New customers in the last 7 days\n    rule:\n      type: And\n      conditions:\n        - type: Value\n          attribute: created_date\n          operator:\n            type: TimeWithinPast\n            value: 7\n            unit: day\n\n  engaged-users:\n    description: Users who opened welcome email\n    rule:\n      type: And\n      conditions:\n        - type: Value\n          attribute: welcome_email_opened\n          operator:\n            type: Equal\n            value: true\n\n# Journeys array - always present (even for single version)\njourneys:\n  - stages:\n      - name: Welcome\n        description: Initial welcome and introduction\n\n        # Entry criteria - who enters this stage?\n        entry_criteria:\n          name: New Users\n          segment: entry-customers  # Reference to embedded segment above\n\n        # Exit criteria - when to remove from stage (optional)\n        exit_criteria:\n          - name: Churned\n            segment: ref:Churned Users  # ref: prefix for external segments\n\n        # Milestone - optional tracking point\n        milestone:\n          name: Welcome Email Opened\n          segment: engaged-users\n\n        # Steps define the flow within this stage\n        # Uses GitHub Actions-like format: type, name, with (type-specific params)\n        steps:\n          # Wait step - pause before action\n          - type: wait\n            name: Wait 1 Day\n            with:\n              duration: 1\n              unit: day  # day/days | week/weeks\n\n          # Activation step - send to external system\n          - type: activation\n            name: Send Welcome Email\n            with:\n              activation: \"Salesforce Marketing Cloud\"  # Reference by name\n\n          # Decision point - branch based on behavior\n          - type: decision_point\n            name: Check Email Open\n            with:\n              branches:\n                - name: Opened Email\n                  segment: engaged-users\n                  next: send_followup\n                - name: Did Not Open\n                  segment: ref:Did Not Open Welcome  # External segment\n                  excluded: true  # This is the \"else\" branch\n                  next: send_reminder\n\n          # End step - exit the stage (no 'with' needed)\n          - type: end\n            name: Stage Complete\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"segment-references","__idx":7},"children":["Segment References"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Journey YAML supports two types of segment references:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Syntax"},"children":["Syntax"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Embedded segment (defined in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments:"]}," section)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segment: entry-customers"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ref:Name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["External segment (existing child segment)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segment: ref:High Value Customers"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When pulling journeys, journey-local segments are automatically embedded, while references to external segments use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ref:"]}," prefix."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"segment-reference-conditions","__idx":8},"children":["Segment Reference Conditions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Within segment rules, you can include or exclude members of other segments using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: include"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: exclude"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"segments:\n  # Include members of another segment\n  vip_in_california:\n    description: VIP customers in California\n    rule:\n      type: And\n      conditions:\n        - type: include\n          segment: california_customers\n        - type: Value\n          attribute: tier\n          operator:\n            type: Equal\n            value: vip\n\n  # Exclude members of another segment\n  new_non_churned:\n    description: New users who haven't churned\n    rule:\n      type: And\n      conditions:\n        - type: Value\n          attribute: signup_date\n          operator:\n            type: TimeWithinPast\n            value: 30\n            unit: day\n        - type: exclude\n          segment: churned_users\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: include"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include profiles that are members of the referenced segment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: exclude"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Exclude profiles that are members of the referenced segment"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"unified-journeys-format","__idx":9},"children":["Unified Journeys Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All journeys use a unified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journeys"]}," array format, whether single or multi-version:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"type: journey\nname: Onboarding Journey\ndescription: New customer onboarding flow\n\n# Shared properties (reentry, segments) at top level\nreentry: no_reentry\n\nsegments:\n  entry-customers:\n    description: New customers\n    rule:\n      # ...\n\n# Journeys array - each entry is a version\njourneys:\n  - version: v1\n    state: launched\n    latest: true  # Active version\n    goal:\n      name: Completed Onboarding\n      segment: entry-customers\n    stages:\n      - name: Welcome\n        # ...\n\n  - version: v2\n    state: draft\n    goal:\n      name: Completed V2\n      segment: active-customers\n    stages:\n      - name: Welcome (New)\n        # ...\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key features:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journeys"]}," array is always present (even for single-version journeys)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["goal"]}," is defined per version entry (each version can have its own goal or none)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Shared properties (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reentry"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]},") at top level apply to all versions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}," property is optional (defaults to \"v1\" for single-version)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["latest: true"]}," marks the active version"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}," indicates draft or launched"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-types","__idx":10},"children":["Step Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All steps use a consistent format with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", and type-specific parameters nested under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["with"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"with Parameters"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["with"]}," Parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["wait"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pause execution"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["duration"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unit"]}," (day/week)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["activation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send to external system"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["activation"]}," (name reference)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["decision_point"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Branch based on segment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["branches[]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ab_test"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Split traffic for testing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["variants[]"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customized_split"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merge"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rejoin branched paths"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(none - only uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jump"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Go to another journey/stage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["target.journey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["target.stage"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["target.bundle_id"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Exit the stage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(none - terminates flow)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"wait-step-options","__idx":11},"children":["Wait Step Options"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Duration-based wait\n- type: wait\n  name: Wait 7 Days\n  with:\n    duration: 7\n    unit: day  # day | week\n\n# Wait until specific date\n- type: wait\n  name: Wait Until Holiday\n  with:\n    wait_until: \"2024-12-25T00:00:00Z\"\n\n# Wait until condition met (with timeout)\n- type: wait\n  name: Wait for Purchase\n  with:\n    condition:\n      segment: \"Made Purchase\"\n      timeout:\n        duration: 14\n        unit: day\n\n# Wait with different paths for matched vs timeout\n- type: wait\n  name: Wait for Purchase\n  with:\n    condition:\n      segment: made-purchase      # Wait until segment match\n      next: follow-up             # Optional: step when matched (defaults to next step)\n      timeout:\n        duration: 14\n        unit: day\n        next: timeout-path        # Step when timeout - triggers branching\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Condition Branching"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeout.next"]}," is specified, the wait step branches into two paths:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Matched path"]},": Profiles matching the segment go to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["condition.next"]}," (or the next sequential step if omitted)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Timeout path"]},": Profiles not matching within the duration go to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeout.next"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"decision-point-branches","__idx":12},"children":["Decision Point Branches"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"- type: decision_point\n  name: Check Engagement\n  with:\n    branches:\n      - name: High Engagement\n        segment: \"Active Users\"  # Child segment reference\n        next: premium_path\n      - name: Medium Engagement\n        segment: \"Moderate Users\"\n        next: nurture_path\n      - name: Low Engagement\n        excluded: true  # Catch-all for remaining\n        next: reactivation_path\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"jump-to-another-journey","__idx":13},"children":["Jump to Another Journey"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use jump steps to transfer profiles to another journey or stage:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Jump to another journey (by name)\n- type: jump\n  name: Continue in Retention Journey\n  with:\n    target:\n      journey: \"Retention Campaign\"  # Journey name\n      stage: \"Welcome Back\"          # Target stage name\n\n# Jump to a journey in a folder\n- type: jump\n  name: Move to VIP Journey\n  with:\n    target:\n      journey: \"Marketing/VIP Journey\"  # Folder path + journey name\n      stage: \"Entry\"\n\n# Jump to a local journey file (same project)\n- type: jump\n  name: Next Journey\n  with:\n    target:\n      journey: retention-journey.yml  # Local .yml file reference\n      stage: \"Stage 1\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Target Reference Formats:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Format"},"children":["Format"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey in root folder"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journey: \"My Journey\""]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Folder/Journey"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey in subfolder"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journey: \"Marketing/Campaign\""]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["file.yml"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Local journey file"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journey: \"other-journey.yml\""]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Cross-Journey Orchestration"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Jump steps enable complex multi-journey workflows. Profiles exit the current journey and enter the target journey at the specified stage."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commands-reference","__idx":14},"children":["Commands Reference"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list","__idx":15},"children":["list"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List journeys in the current parent segment context."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey list [pattern] [options]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-r, --recursive"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List recursively (tree view)"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List all journeys in context\ntdx journey list\n\n# Filter by pattern\ntdx journey list \"*onboarding*\"\n\n# List recursively\ntdx journey list -r\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"view","__idx":16},"children":["view"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show journey details including stages and statistics."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey view <name-or-path> [options]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Journey name: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Onboarding Journey\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Path notation: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"My Audience/Onboarding Journey\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["YAML file path: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments/my-audience/onboarding-journey.yml"]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--include-stats"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include execution statistics"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# View journey by name\ntdx journey view \"Onboarding Journey\"\n\n# View journey by path\ntdx journey view \"My Audience/Onboarding Journey\"\n\n# View journey from YAML file\ntdx journey view segments/my-audience/onboarding-journey.yml\n\n# View with statistics\ntdx journey view \"Onboarding Journey\" --include-stats\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To view a specific version, use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#version-view"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version view"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pull","__idx":17},"children":["pull"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pull journey configurations to local YAML files."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey pull [name] [options]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--dry-run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Preview changes without writing files"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-y, --yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Skip confirmation prompt"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Pull all journeys (requires context or tdx.json)\ntdx journey pull\n# Creates: segments/<parent>/*.yml (with type: journey)\n\n# Pull specific journey\ntdx journey pull \"Onboarding Journey\"\n\n# Preview what would be pulled\ntdx journey pull --dry-run\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The pull command:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Stores journeys alongside segments in the parent segment folder"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Embeds journey-local segments in the YAML file"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ref:Name"]}," syntax for references to external segments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Shows diff for changed files before writing"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"push","__idx":18},"children":["push"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Push journey YAML files to Treasure AI. This command pushes only journeys, without affecting segments or activations."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey push [target] [options]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[target]"]}," argument can be:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A directory path containing journey YAML files"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A specific YAML file path"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Omitted to use the current directory or context"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--dry-run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Preview changes without applying"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-y, --yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Skip confirmation prompt"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Preview journey changes\ntdx journey push --dry-run\n\n# Push journey changes\ntdx journey push\n\n# Push specific directory\ntdx journey push segments/my-audience\n\n# Push specific journey file\ntdx journey push segments/my-audience/onboarding-journey.yml\n\n# Push all files (segments, journeys, and activations)\ntdx sg push\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Journey-Only Mode"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx journey push"]}," is equivalent to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx sg push"]}," but only processes journey files (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: journey"]},"). Use it when you want to update journeys without modifying segments or activations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"validate","__idx":19},"children":["validate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Validate journey YAML files locally without pushing to Treasure AI. This catches syntax errors, missing embedded segment references, and invalid step configurations before pushing."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey validate [target]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Argument"},"children":["Argument"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["target"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["File or directory to validate (optional, defaults to context directory)"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Validate all journeys in context directory\ntdx journey validate\n\n# Validate a specific journey file\ntdx journey validate onboarding-journey.yml\n\n# Validate journeys in a specific directory\ntdx journey validate segments/my-audience\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Validations performed:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," or empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stages"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Duplicate step names within journey"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next"]}," step references (must point to existing step)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Wait step condition references to undefined embedded segments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Decision branch references to undefined segments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A/B test variant percentages not summing to 100%"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid jump step targets"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Embedded segment rule validation"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Validation also runs automatically before ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx journey push"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx sg push"]},", so errors are caught even if you skip this command."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"run","__idx":20},"children":["run"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Trigger on-demand execution of a journey workflow."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey run <name-or-path> [--dry-run] [-y]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports journey name, path notation, or YAML file path."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The run uses the most recent completed parent-segment output — it does ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," trigger a parent-segment refresh. Activations that are configured to fire on parent-segment refresh will not fire from this command."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Trigger on-demand workflow execution (prompts for confirmation)\ntdx journey run \"Onboarding Journey\"\n\n# Skip the confirmation prompt\ntdx journey run \"Onboarding Journey\" -y\n\n# Trigger from a YAML file path\ntdx journey run segments/my-audience/onboarding-journey.yml\n\n# Preview what would run, without triggering\ntdx journey run \"Onboarding Journey\" --dry-run\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--dry-run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show journey details and activation targets without triggering"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-y, --yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Skip the confirmation prompt"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On success, the command prints the session ID and a console URL for the workflow session:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"✔ Journey workflow started\n  Journey: Onboarding Journey\n  Status: running\n  Session: 18283291\n  https://console.treasuredata.com/app/workflows/40212/sessions/18283291\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The command exits with an error if the workflow is already in progress (409) or if the journey is not eligible for on-demand execution — for example, the journey is not active, or belongs to a Priority Group (422)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"dry-run-preview","__idx":21},"children":["Dry-Run Preview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--dry-run"]}," prints the journey's state, stages, and every activation the run would consider —"," ","connection ID, schedule, and whether the activation is configured to fire on parent-segment refresh"," ","(activations tagged ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[runs on refresh]"]}," will ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," fire from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journey run"]},", since the command does"," ","not trigger a refresh). Useful for verifying targets before triggering."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"$ tdx journey run predict_churn --parent-segment \"[ko] td_customer\" --dry-run\nJourney: predict_churn\nID: 76274\nState: launched\nPaused: no\nParent segment ID: 706882\nStages: 1 (predict and send emails)\n\nActivations:\n  ⚠️  send emails  ← connection 328374, schedule: daily\n\n[Dry run] Journey workflow was NOT triggered.\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pause","__idx":22},"children":["pause"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pause a running journey and its activations."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey pause <name-or-path>\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports journey name, path notation, or YAML file path."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Pause journey by name\ntdx journey pause \"Onboarding Journey\"\n\n# Pause journey from YAML file\ntdx journey pause segments/my-audience/onboarding-journey.yml\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"resume","__idx":23},"children":["resume"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Resume a paused journey."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey resume <name-or-path> [--dry-run]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports journey name, path notation, or YAML file path."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Resume journey by name\ntdx journey resume \"Onboarding Journey\"\n\n# Resume journey from YAML file\ntdx journey resume segments/my-audience/onboarding-journey.yml\n\n# Preview what resume will fire, without actually resuming\ntdx journey resume \"Onboarding Journey\" --dry-run\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--dry-run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show journey details and activation targets without resuming"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"dry-run-preview-1","__idx":24},"children":["Dry-Run Preview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--dry-run"]}," prints the journey's state, stages, and every activation the resume would fire —"," ","connection ID, schedule, and whether it runs on the next parent-segment refresh. Useful"," ","before re-enabling a journey that was paused mid-campaign."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"$ tdx journey resume predict_churn --parent-segment \"[ko] td_customer\" --dry-run\nJourney: predict_churn\nID: 76274\nState: draft\nPaused: no\nParent segment ID: 706882\nStages: 1 (predict and send emails)\n\nActivations:\n  ⚠️  send emails  ← connection 328374, schedule: daily\n\n[Dry run] Journey was NOT resumed.\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"stats","__idx":25},"children":["stats"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show journey statistics including stage populations and conversion rates."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey stats <name-or-path> [options]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports journey name, path notation, or YAML file path."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--stage <name>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show stats for specific stage"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--from <date>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start date for period filter (YYYY-MM-DD)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--to <date>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End date for period filter (YYYY-MM-DD)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--include-history"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include raw history data in output"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Show overall journey stats\ntdx journey stats \"Onboarding Journey\"\n\n# Show specific stage stats\ntdx journey stats \"Onboarding Journey\" --stage \"Welcome\"\n\n# Show stats for a specific period\ntdx journey stats \"Onboarding Journey\" --from 2026-01-01 --to 2026-01-31\n\n# Include raw history entries (auto-switches to JSON output)\ntdx journey stats \"Onboarding Journey\" --from 2026-01-01 --to 2026-01-31 --include-history\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"traffic","__idx":26},"children":["traffic"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get journey traffic data as Sankey chart structures (conversion and activation flows)."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey traffic <name-or-path> [options]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports journey name, path notation, or YAML file path."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--type <type>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Chart type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversion"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["activation"]}," (default: both)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--from <date>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start date for period filter (YYYY-MM-DD)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--to <date>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End date for period filter (YYYY-MM-DD)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--limit <number>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum number of nodes"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Output is always JSON (Sankey graph data is not suited for table display)."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversion"]},": Stage-to-stage flow showing goal, exit, and jump transitions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Activation"]},": Per-stage activation conversion rates"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Get both conversion and activation data\ntdx journey traffic \"Onboarding Journey\"\n\n# Get only conversion Sankey\ntdx journey traffic \"Onboarding Journey\" --type conversion\n\n# Get activation data for a specific period\ntdx journey traffic \"Onboarding Journey\" --type activation --from 2026-01-01 --to 2026-01-31\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"columns","__idx":27},"children":["columns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show the column mapping for a journey's Trino table. Maps each column name to its corresponding stage, step, and type."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey columns <name-or-path>\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports journey name, path notation, or YAML file path."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Output includes the database/table name and a column list with stage index, step type, step name, direction (in/out), and category."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Show column mapping for a journey\ntdx journey columns \"Onboarding Journey\"\n\n# Show columns from YAML file\ntdx journey columns segments/my-audience/onboarding-journey.yml\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"activations","__idx":28},"children":["activations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List all activations configured for a journey."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey activations <name-or-path>\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports journey name, path notation, or YAML file path."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List activations for a journey\ntdx journey activations \"Onboarding Journey\"\n\n# List activations from YAML file\ntdx journey activations segments/my-audience/onboarding-journey.yml\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"versions","__idx":29},"children":["versions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List all versions of a journey bundle."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey versions <name-or-path>\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name-or-path>"]}," argument supports journey name, path notation, or YAML file path."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List all versions\ntdx journey versions \"Onboarding Journey\"\n\n# List versions from YAML file\ntdx journey versions segments/my-audience/onboarding-journey.yml\n\n# JSON output\ntdx journey versions \"Onboarding Journey\" --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output fields:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journey_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey ID for this version"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey state (draft, simulation, launched)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paused"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether this version is paused"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["latest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether this is the latest version"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation timestamp"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"version-create","__idx":30},"children":["version create"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new draft version of a journey. The new version is cloned from the specified journey (typically the latest version)."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey version create <name-or-path>\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-y, --yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Skip confirmation prompt"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Create a new draft version (with confirmation prompt)\ntdx journey version create \"Onboarding Journey\"\n\n# Skip confirmation\ntdx journey version create \"Onboarding Journey\" -y\n\n# Create from YAML file reference\ntdx journey version create segments/my-audience/onboarding-journey.yml\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The new version name is auto-generated as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{bundle name} v{N+1}"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See also: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#versions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["versions"]}]}," to list existing versions before creating a new one."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"version-view","__idx":31},"children":["version view"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["View details of a specific version of a journey. Similar to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#view"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["view"]}]}," but targets a specific version number."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx journey version view <name-or-path> --version <number>\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--version <number>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version number to view (required)"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# View version 1\ntdx journey version view \"Onboarding Journey\" --version 1\n\n# View version 3 in JSON format\ntdx journey version view \"Onboarding Journey\" --version 3 --json\n\n# View from YAML file reference\ntdx journey version view segments/my-audience/onboarding-journey.yml --version 2\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output fields:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey description"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey state"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paused"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether paused"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reentry_mode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profile reentry behavior"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stages"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of stages"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["goal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Goal name (if set)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["latest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether this is the latest version"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation timestamp"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updated_at"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last update timestamp"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Console URL"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"journey-states","__idx":32},"children":["Journey States"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"State"},"children":["State"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["draft"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey is being edited, not yet launched"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["simulation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Running in simulation mode for testing"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["launched"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey is live and processing profiles"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paused"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey is paused, no new profiles enter"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":33},"children":["Best Practices"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"stage-design","__idx":34},"children":["Stage Design"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Limit stages to 8 maximum"]}," - Keep journeys focused and manageable"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Clear entry criteria"]}," - Each stage should have well-defined entry conditions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use milestones for tracking"]}," - Add milestones to measure intermediate success"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Plan exit criteria"]}," - Define when profiles should leave the journey"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"activation-setup","__idx":35},"children":["Activation Setup"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test activations first"]}," - Ensure activations work before adding to journey"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use A/B testing"]}," - Test different approaches before full rollout"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Monitor delivery rates"]}," - Check activation success in statistics"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"activation-configuration","__idx":36},"children":["Activation Configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Journey activations can include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," for connector-specific settings:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"steps:\n  - type: activation\n    name: Export to S3\n    with:\n      activation:\n        name: S3 Export\n        connection: my-s3-connection\n        all_columns: true\n        connector_config:\n          bucket: my-bucket\n          path: journey-exports/users.csv\n          format: csv\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Schema Validation"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When pushing journeys, tdx automatically validates ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," against the connector's schema. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection schema <type>"]}," to see available fields for each connector type."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reentry-strategy","__idx":37},"children":["Reentry Strategy"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Strategy"},"children":["Strategy"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use Case"},"children":["Use Case"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["no_reentry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One-time journeys (welcome, onboarding)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reentry_unless_goal_achieved"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Repeat until goal met (conversion)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reentry_always"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recurring journeys (monthly engagement)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"learn-more","__idx":38},"children":["Learn More"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.treasuredata.com/products/customer-data-platform/journey-orchestration"},"children":["Journey Orchestration Documentation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/treasure-code/commands/parent-segment"},"children":["Parent Segment Commands"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/treasure-code/commands/segment"},"children":["Segment Commands"]}]}]}]},"headings":[{"value":"Journey Commands","id":"journey-commands","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Key Concepts","id":"key-concepts","depth":3},{"value":"Commands","id":"commands","depth":2},{"value":"Typical Workflow","id":"typical-workflow","depth":2},{"value":"YAML Format","id":"yaml-format","depth":2},{"value":"Journey YAML Schema","id":"journey-yaml-schema","depth":3},{"value":"Segment References","id":"segment-references","depth":3},{"value":"Segment Reference Conditions","id":"segment-reference-conditions","depth":3},{"value":"Unified Journeys Format","id":"unified-journeys-format","depth":3},{"value":"Step Types","id":"step-types","depth":3},{"value":"Wait Step Options","id":"wait-step-options","depth":3},{"value":"Decision Point Branches","id":"decision-point-branches","depth":3},{"value":"Jump to Another Journey","id":"jump-to-another-journey","depth":3},{"value":"Commands Reference","id":"commands-reference","depth":2},{"value":"list","id":"list","depth":3},{"value":"view","id":"view","depth":3},{"value":"pull","id":"pull","depth":3},{"value":"push","id":"push","depth":3},{"value":"validate","id":"validate","depth":3},{"value":"run","id":"run","depth":3},{"value":"Dry-Run Preview","id":"dry-run-preview","depth":4},{"value":"pause","id":"pause","depth":3},{"value":"resume","id":"resume","depth":3},{"value":"Dry-Run Preview","id":"dry-run-preview-1","depth":4},{"value":"stats","id":"stats","depth":3},{"value":"traffic","id":"traffic","depth":3},{"value":"columns","id":"columns","depth":3},{"value":"activations","id":"activations","depth":3},{"value":"versions","id":"versions","depth":3},{"value":"version create","id":"version-create","depth":3},{"value":"version view","id":"version-view","depth":3},{"value":"Journey States","id":"journey-states","depth":2},{"value":"Best Practices","id":"best-practices","depth":2},{"value":"Stage Design","id":"stage-design","depth":3},{"value":"Activation Setup","id":"activation-setup","depth":3},{"value":"Activation Configuration","id":"activation-configuration","depth":3},{"value":"Reentry Strategy","id":"reentry-strategy","depth":3},{"value":"Learn More","id":"learn-more","depth":2}],"frontmatter":{"seo":{"title":"tdx journey - Journey Orchestration | Treasure Data","description":"Manage CDP Journey Orchestration with YAML files. Create and automate customer journeys with tdx.","image":"/assets/og-image.ba836864a30434f560a4f7720f8a09019ad30ff828b20c5052ae933ba7121524.d7ef4821.png"}},"lastModified":"2026-05-27T01:10:46.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/treasure-code/commands/journey","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}