{"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 segment - CDP Segment Management | Treasure Data","description":"Manage CDP segments with YAML files. Pull, push, validate segments and configure activations.","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":"segment-commands","__idx":0},"children":["Segment Commands"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage CDP segments for audiences and activations."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Alias"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx sg"]}," is an alias for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx segment"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commands","__idx":1},"children":["Commands"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"navigation--discovery","__idx":2},"children":["Navigation & Discovery"]},{"$$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":"#use"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["use"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set parent segment context"]}]},{"$$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 folders and segments"]}]},{"$$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 segment details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#desc"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["desc"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show segment schema (column types)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#show"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["show"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Execute segment SQL and show results"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#sql"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sql"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get SQL query for segment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#fields"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List available fields for segmentation"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"yaml-sync","__idx":3},"children":["YAML Sync"]},{"$$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":"#pull"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pull"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pull child segments to YAML files"]}]},{"$$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 files to TD as child segments"]}]},{"$$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 segment and journey YAML files locally"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typical-usage","__idx":4},"children":["Typical Usage"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# 0. List available parent segments\ntdx ps list\n\n# 1. Pull all child segments from a parent to YAML files\n# (this also sets parent_segment context)\ntdx sg pull \"My Audience\"\n# Creates: segments/my-audience/\n\n# 2. Edit YAML files locally (add/modify segments and activations)\n# Edit segments/my-audience/high-value-customers.yml with your text editor\n\n# 3. Push changes back to TD (syncs segments and activations)\ntdx sg push\n\n# 4. Review segments in TD (context already set by pull)\ntdx sg list -r\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The pull/push workflow enables version control and code review for segment definitions:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Work from any subdirectory - push finds tdx.json automatically\ncd segments/my-audience/marketing\n# Edit newsletter-subs.yml\ntdx sg push # Push all changes from root\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":5},"children":["How It Works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Child segments"]}," define filtered audiences within a parent segment. They use rules (conditions) to filter customers from the parent segment's enriched data. Each child segment can have one or more ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["activations"]}," that export the filtered audience to external systems."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx sg"]}," commands help you manage child segments as local YAML files. You can ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pull"]}," existing segments from Treasure AI, edit them locally, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," changes back. The YAML files include both segment rules and activation configurations."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TB\n subgraph LOCAL[\"Local\"]\n YAML[\"segments/<parent>/*.yml\"]\n CLI[\"tdx sg desc/show/sql\"]\n end\n\n subgraph TD[\"Treasure AI\"]\n API[\"CDP API\"]\n subgraph PS[\"Parent Segment\"]\n PARENT[(\"Enriched
Customer Data\")]\n end\n CHILD[\"Child Segments\"]\n ACT[\"Activations\"]\n EXT[\"External Systems
(S3, Salesforce, etc.)\"]\n end\n\n YAML <-->|\"pull / push\"| API\n CLI -.->|\"query\"| CHILD\n API --> CHILD\n PARENT -->|\"filtered by rules\"| CHILD\n CHILD -->|\"activations\"| ACT\n ACT -->|\"export\"| EXT\n","diagramHtml":"

Treasure AI

Local

Parent Segment

pull / push

query

filtered by rules

activations

export

segments/<parent>/*.yml

tdx sg desc/show/sql

CDP API

Enriched
Customer Data

Child Segments

Activations

External Systems
(S3, Salesforce, etc.)

","diagramHtmlDark":"

Treasure AI

Local

Parent Segment

pull / push

query

filtered by rules

activations

export

segments/<parent>/*.yml

tdx sg desc/show/sql

CDP API

Enriched
Customer Data

Child Segments

Activations

External Systems
(S3, Salesforce, etc.)

"},"children":["flowchart TB\n subgraph LOCAL[\"Local\"]\n YAML[\"segments/<parent>/*.yml\"]\n CLI[\"tdx sg desc/show/sql\"]\n end\n\n subgraph TD[\"Treasure AI\"]\n API[\"CDP API\"]\n subgraph PS[\"Parent Segment\"]\n PARENT[(\"Enriched
Customer Data\")]\n end\n CHILD[\"Child Segments\"]\n ACT[\"Activations\"]\n EXT[\"External Systems
(S3, Salesforce, etc.)\"]\n end\n\n YAML <-->|\"pull / push\"| API\n CLI -.->|\"query\"| CHILD\n API --> CHILD\n PARENT -->|\"filtered by rules\"| CHILD\n CHILD -->|\"activations\"| ACT\n ACT -->|\"export\"| EXT\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"folder-structure","__idx":6},"children":["Folder Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pull creates individual YAML files for each segment, organized by folder:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"segments/\nā””ā”€ā”€ my-audience/ # Normalized from \"My Audience\"\n ā”œā”€ā”€ tdx.json # { \"parent_segment\": \"My Audience\" }\n ā”œā”€ā”€ active-users.yml # Root-level segment\n ā”œā”€ā”€ high-value-customers.yml # Another root-level segment\n ā”œā”€ā”€ marketing/\n ā”‚ ā”œā”€ā”€ email-subscribers.yml # Segment in Marketing folder\n ā”‚ ā””ā”€ā”€ newsletter-subs.yml # Another segment in folder\n ā””ā”€ā”€ sales/\n ā”œā”€ā”€ enterprise-leads.yml # Segment in Sales folder\n ā””ā”€ā”€ q1/\n ā””ā”€ā”€ q1-targets.yml # Segment in Sales/Q1 folder\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each segment file includes its activations (syndications), enabling file-based management of your CDP configuration."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"context-based-workflow","__idx":7},"children":["Context-Based Workflow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Child segment commands require a parent segment context. Set it using one of these methods:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Option 1: Use the segment use command\ntdx sg use \"My Audience\"\n\n# Option 2: Pull sets context automatically\ntdx sg pull \"My Audience\"\n\n# Now run segment commands without specifying parent\ntdx sg list # List folders and segments in \"My Audience\"\ntdx sg view \"Premium Users\" # View child segment details\ntdx sg desc \"Premium Users\" # Show segment schema\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Names are case-sensitive. Pattern matching (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?"]},") is supported for filtering."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commands-1","__idx":8},"children":["Commands"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"use","__idx":9},"children":["use"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set or show the parent segment context for subsequent commands."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg use [name]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Set parent segment context\ntdx sg use \"My Audience\"\n\n# Show current context (no argument)\ntdx sg use\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list","__idx":10},"children":["list"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List folders and segments within the current parent segment context."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg list [folder] [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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--max-depth "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum recursion depth (default: 10)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-w, --web"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show web console URLs for segments"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# First, set parent segment context\ntdx use parent_segment \"My Audience\"\n\n# List folders and segments in context\ntdx sg list\n\n# List contents of a specific folder\ntdx sg list \"Marketing\"\n\n# Filter by pattern (glob)\ntdx sg list \"*Premium*\"\n\n# List recursively (tree view)\ntdx sg list -r\n\n# Show web console URLs for each segment\ntdx sg list -w\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"JSON Output"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--json"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--jsonl"]}," output, URLs are always included in the response."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Listing Parent Segments"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx ps list"]}," to list available parent segments."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"view","__idx":11},"children":["view"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show details of a folder or child segment within the current context."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg view [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":["-w, --web"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Open segment in web browser"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Show folder details\ntdx sg view \"Marketing\"\n\n# Show child segment details (includes web console URL)\ntdx sg view \"Premium Users\"\n\n# Open segment in web browser\ntdx sg view \"Premium Users\" -w\n\n# JSON output\ntdx sg view \"Premium Users\" --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Web Console URL"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The output always includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}," field with a link to the segment in the Treasure AI web console."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"desc","__idx":12},"children":["desc"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show schema (column names and types) for a child segment."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg desc [name]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Show schema for child segment\ntdx sg desc \"Premium Users\"\n\n# JSON output\ntdx sg desc \"Premium Users\" --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"show","__idx":13},"children":["show"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Execute segment SQL query and show results."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg show [name]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Execute segment SQL query and show results\ntdx sg show \"Premium Users\"\n\n# With output format\ntdx sg show \"Premium Users\" --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sql","__idx":14},"children":["sql"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get SQL query for a child segment."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg sql [name]\ntdx sg sql --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":["--path "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["YAML file path for unpushed segment"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Get SQL query for server-side segment\ntdx sg sql \"Premium Users\"\n\n# For segments in folders, include folder path\ntdx sg sql \"Marketing/Newsletter Subscribers\"\n\n# Get SQL from local YAML file (before pushing)\ntdx sg sql --path segments/my-audience/premium-users.yml\n\n# JSON output\ntdx sg sql \"Premium Users\" --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"fields","__idx":15},"children":["fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List available fields for segmentation in the current parent segment context."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg fields\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List available fields (uses parent_segment context)\ntdx sg fields\n\n# JSON output\ntdx sg fields --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pull","__idx":16},"children":["pull"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pull all child segments from a parent segment to individual YAML files. This also sets the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parent_segment"]}," context for subsequent commands."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg pull [parent_name]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parent_name"]}," argument is optional if you have set a parent segment context with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx sg use"]},"."]},{"$$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":"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":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Pull all segments from parent (sets context)\ntdx sg pull \"My Audience\"\n\n# Preview changes without writing files\ntdx sg pull \"My Audience\" --dry-run\n\n# Skip confirmation prompt\ntdx sg pull \"My Audience\" -y\n\n# With context set (tdx sg use \"My Audience\")\ntdx sg pull\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output includes:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Number of segments and activations found"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New, changed, and unchanged files"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Diff preview for changed files"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"push","__idx":17},"children":["push"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Push individual segment YAML files to Treasure AI. Uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parent_segment"]}," context or detects parent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx.json"]}," in the segments directory."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg push [directory]\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":"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":["--delete"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete segments not in local YAML files"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Push all segments (uses context or tdx.json)\ntdx sg push\n\n# Push from specific directory\ntdx sg push segments/my-audience\n\n# Preview changes without applying\ntdx sg push --dry-run\n\n# Skip confirmation prompt\ntdx sg push -y\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Features:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Automatically creates missing TD folders"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Shows diff before applying changes (segments and activations)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Shows segments/activations that will be deleted (exist on server but not in YAML)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Syncs activations by name (create/update/delete)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Creates new segments or updates existing ones based on segment name"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Asks for confirmation before applying changes"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"validate","__idx":18},"children":["validate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Validate segment and journey YAML files locally without pushing to Treasure AI. This is useful to catch syntax errors, missing references, and invalid configurations before pushing."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx sg 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 segments and journeys in context directory\ntdx sg validate\n\n# Validate a specific file\ntdx sg validate high-value-customers.yml\n\n# Validate a specific directory\ntdx sg 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":"p","attributes":{},"children":["For segments:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Missing or empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," field"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Empty attribute values in conditions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid operator types"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Missing required operator fields (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}," for Equal, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["min"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["max"]}," for Between)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["arrayMatching"]}," configuration"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For journeys:"]},{"$$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"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next"]}," step references"]},{"$$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":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example output:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"āœ” high-value-customers.yml (segment)\n\nāœ– bad-journey.yml (journey): 2 error(s)\n\nbad-journey.yml:15:7: error [MISSING_SEGMENT_REFERENCE]\nWait condition references undefined segment 'missing_segment'\n 14 | condition:\n 15 | segment: missing_segment\n | ^\n 16 | next: to_end\n\nbad-journey.yml:22:5: error [INVALID_NEXT_REFERENCE]\nStep references non-existent step 'nonexistent'\n 21 | name: activation_step\n 22 | next: nonexistent\n | ^\n 23 | with:\n\nValidation failed: 1 file(s) with errors, 1 valid\n"},"children":[]},{"$$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 sg push"]},", so you can catch errors early in your workflow."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"segment-yaml-schema","__idx":19},"children":["Segment YAML Schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each segment has its own YAML file with optional activations:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# segments/my-audience/us-customers.yml\nname: US Customers\ndescription: All customers in the United States\n\nrule:\n type: Value\n attribute: country\n operator:\n type: Equal\n value: US\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# segments/my-audience/marketing/high-value-customers.yml\nname: High Value Customers\ndescription: Customers with LTV > $1000\nkind: batch # batch, realtime, or funnel_stage\nvisible: true # Show in UI (default: true)\n\nrule:\n type: And\n conditions:\n - type: Value\n attribute: ltv\n operator:\n type: Greater\n value: 1000\n\nactivations:\n - name: Daily Salesforce Sync\n description: Sync high-value customers to SFDC daily\n connection: my-salesforce-connection\n all_columns: false\n columns:\n - email\n - first_name\n - last_name\n - ltv\n schedule:\n type: daily\n timezone: America/Los_Angeles\n connector_config:\n object: Contact\n mode: upsert\n\n - name: Weekly Marketing Cloud Export\n connection: marketing-cloud-export\n all_columns: true\n schedule:\n type: weekly\n repeat_sub_frequency: [1] # Monday\n timezone: UTC\n notification:\n notify_on:\n - onSuccess\n - onFailure\n email_recipients:\n - user@example.com # Must be TD account email\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"activation-schema","__idx":20},"children":["Activation Schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Activations (syndications) define how segment data is exported to external systems:"]},{"$$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":"th","attributes":{"data-label":"Required"},"children":["Required"]}]}]},{"$$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":["Activation name (used for matching)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$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":["Description"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connection"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TD Connection name (use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connections"]}," to list)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["all_columns"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Export all columns"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No (default: false)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["columns"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Columns to export (if not all_columns)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schedule"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Schedule configuration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Connector-specific settings (see below)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notification"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notification settings (see below)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Finding Connection Names"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connections"]}," to list available connections and their names:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"tdx connections\n","lang":"bash"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Schedule Types:"]}]},{"$$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":"Additional Fields"},"children":["Additional Fields"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manual trigger only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minutes_interval"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run every N minutes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["repeat_frequency"]}," (interval in minutes)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hourly"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run every hour"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["daily"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run daily"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timezone"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weekly"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run weekly"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["repeat_sub_frequency"]}," (day numbers 0-6), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timezone"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["monthly"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run monthly"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["repeat_sub_frequency"]}," (day numbers 1-31), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timezone"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cron"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cron expression"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cron"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timezone"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Column Format:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Columns can be simple strings or objects with additional properties:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"columns:\n # Simple column name\n - email\n - first_name\n\n # Column with visibility setting\n - name: ssn\n visibility: masked # clear or masked\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notification Settings:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure email notifications for activation runs:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"notification:\n notify_on:\n - onSuccess # Notify on successful completion\n - onFailure # Notify on failure\n email_recipients:\n - user@example.com # Must be TD account email addresses\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":"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":["notify_on"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Events to notify on: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onSuccess"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onFailure"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email_recipients"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of email addresses (must be registered TD account emails)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Connector Config Settings:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," field contains connector-specific settings that vary by connection type. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection schema "]}," to see available fields for a specific connection."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Example: Treasure AI connector\nconnector_config:\n database_name: my_database\n table_name: my_table\n mode: append # append or replace\n\n# Example: Salesforce Marketing Cloud connector\nconnector_config:\n de_name: CustomerSegment\n shared_data_extension: false\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Schema Validation"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When pushing segments, tdx automatically validates ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," against the connector's schema. Invalid values or unknown fields will show helpful error messages:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Error: Invalid connector_config for activation \"My Activation\":\n Ɨ mode: Invalid value for \"Mode\"\n Expected: one of: append, replace\n Received: invalid_mode\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection schema "]}," to see valid field names and values."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"important-behaviors","__idx":21},"children":["Important Behaviors"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Filename Collisions:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When pulling segments, filenames are sanitized (lowercase, spaces to hyphens). If two segments would result in the same filename (e.g., \"My Segment\" and \"my-segment\"), numeric suffixes are added:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["my-segment.yml"]}," (first segment)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["my-segment-1.yml"]}," (second segment)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Activation Matching:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Activations are matched by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," only. This has important implications:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Renaming an activation"]}," in YAML will delete the old activation and create a new one (losing execution history and statistics)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To preserve an activation's history, update its properties without changing the name"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Segment Matching:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Segments are matched by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["folder + name"]},". This means:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You can have segments with the same name in different folders"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Moving a segment YAML file to a different folder creates a new segment (does not move the existing one)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"supported-operators","__idx":22},"children":["Supported Operators"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All operators use the unified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}," field. When multiple values are needed (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["In"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Contain"]},"), provide an array."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"comparison-operators","__idx":23},"children":["Comparison Operators"]},{"$$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":"Operator Type"},"children":["Operator Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required Fields"},"children":["Required Fields"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value Type"},"children":["Value 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":["Equal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string, number, boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Exact match"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotEqual"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string, number, boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not equal (use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not: true"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Equal"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Greater"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Greater than"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GreaterEqual"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Greater than or equal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Less"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Less than"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LessEqual"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Less than or equal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Between"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minValue"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value in range (exclusive)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"list-operators","__idx":24},"children":["List Operators"]},{"$$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":"Operator Type"},"children":["Operator Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required Fields"},"children":["Required Fields"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value Type"},"children":["Value 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":["In"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings/numbers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value in set"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotIn"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings/numbers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value not in set (use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not: true"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["In"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"string-operators","__idx":25},"children":["String Operators"]},{"$$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":"Operator Type"},"children":["Operator Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required Fields"},"children":["Required Fields"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value Type"},"children":["Value 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":["Contain"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains any substring"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["StartWith"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Starts with any prefix"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EndWith"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ends with any suffix"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Regexp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["regex pattern string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Matches regular expression"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"null-operators","__idx":26},"children":["Null Operators"]},{"$$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":"Operator Type"},"children":["Operator Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required Fields"},"children":["Required Fields"]},{"$$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":["IsNull"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(none)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Checks if value is null"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"time-operators","__idx":27},"children":["Time Operators"]},{"$$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":"Operator Type"},"children":["Operator Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required Fields"},"children":["Required Fields"]},{"$$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":["TimeWithinPast"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Within past N time units"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeWithinNext"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Within next N time units"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeToday"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(none)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Matches today"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeThis"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from.unit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current period (this week, this month, etc.)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeNext"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from.unit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Next period (next week, next month, etc.)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeRange"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["duration"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Complex time range"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeInBetweenNext"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Between two future dates"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"time-units","__idx":28},"children":["Time Units"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For time-based operators (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeWithinPast"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeWithinNext"]},", etc.), the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unit"]}," field must be one of:"]},{"$$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":"Unit"},"children":["Unit"]},{"$$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":["year"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Years"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["quarter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quarters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["month"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Months"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["week"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Weeks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["day"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Days"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hour"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hours"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minute"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Minutes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["second"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Seconds"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both singular (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["day"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["week"]},") and plural (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["days"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weeks"]},") forms are accepted. Plural forms are automatically normalized."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"negation-with-not","__idx":29},"children":["Negation with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Most operators support a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not"]}," field to invert the condition:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Emails NOT containing \"@test.com\"\noperator:\n type: Contain\n value: [\"@test.com\"]\n not: true\n\n# Value NOT equal to \"inactive\"\noperator:\n type: Equal\n value: inactive\n not: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"operator-examples","__idx":30},"children":["Operator Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["In (multiple values):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Match customers in US, Canada, or Mexico\noperator:\n type: In\n value: [\"US\", \"CA\", \"MX\"]\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NotIn (exclude multiple values):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Exclude test and spam accounts\noperator:\n type: In\n value: [\"test\", \"spam\", \"internal\"]\n not: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contain (multiple substrings):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Match emails from specific domains\noperator:\n type: Contain\n value: [\"@gmail.com\", \"@yahoo.com\", \"@outlook.com\"]\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["StartWith (multiple prefixes):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Match product SKUs starting with specific prefixes\noperator:\n type: StartWith\n value: [\"PRO-\", \"ENT-\", \"PREM-\"]\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["EndWith (multiple suffixes):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Match files with specific extensions\noperator:\n type: EndWith\n value: [\".pdf\", \".doc\", \".xlsx\"]\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Between (numeric range):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Age between 18 and 65\noperator:\n type: Between\n minValue: 18\n maxValue: 65\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TimeWithinPast:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"operator:\n type: TimeWithinPast\n value: 30\n unit: day # Must be singular\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TimeWithinNext:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"operator:\n type: TimeWithinNext\n value: 7\n unit: day\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TimeThis (current period):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"operator:\n type: TimeThis\n from:\n unit: month # This month\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TimeNext (next period):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"operator:\n type: TimeNext\n from:\n unit: week # Next week\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TimeRange (complex range):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"# Last 3 months\noperator:\n type: TimeRange\n from:\n last: 3\n unit: month\n duration:\n month: 3\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"segment-reference-conditions","__idx":31},"children":["Segment Reference Conditions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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":"rule:\n type: And\n conditions:\n # Include members of another segment\n - type: include\n segment: california_customers\n\n # Exclude members of another segment\n - type: exclude\n segment: churned_users\n\n # Combined with value conditions\n - type: Value\n attribute: tier\n operator:\n type: Equal\n value: premium\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":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segment"]}," field references another child segment by name within the same parent segment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"complex-rule-example","__idx":32},"children":["Complex Rule Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"rule:\n type: And\n conditions:\n # High value OR premium member\n - type: Or\n conditions:\n - type: Value\n attribute: ltv\n operator:\n type: Greater\n value: 1000\n - type: Value\n attribute: membership\n operator:\n type: Equal\n value: premium\n\n # Active within last 30 days\n - type: Value\n attribute: last_activity\n operator:\n type: TimeWithinPast\n unit: day\n value: 30\n\n # Not from test accounts\n - type: Value\n attribute: email\n operator:\n type: Contain\n value:\n - \"@test.com\"\n not: true\n\n # Exclude users already in another segment\n - type: exclude\n segment: already_contacted\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-commands","__idx":33},"children":["Related Commands"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For managing ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["parent segments"]}," (audiences), use the dedicated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx parent-segment"]}," command (alias: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx ps"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/treasure-code/commands/parent-segment"},"children":["Parent Segment Commands"]}," for full documentation including:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list"]}," - List parent segments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pull"]}," - Pull configuration to YAML"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," - Push YAML configuration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validate"]}," - Validate configuration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preview"]}," - Preview sample data"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["run"]}," - Run the workflow"]}]}]},"headings":[{"value":"Segment Commands","id":"segment-commands","depth":1},{"value":"Commands","id":"commands","depth":2},{"value":"Navigation & Discovery","id":"navigation--discovery","depth":3},{"value":"YAML Sync","id":"yaml-sync","depth":3},{"value":"Typical Usage","id":"typical-usage","depth":2},{"value":"How It Works","id":"how-it-works","depth":2},{"value":"Folder Structure","id":"folder-structure","depth":3},{"value":"Context-Based Workflow","id":"context-based-workflow","depth":2},{"value":"Commands","id":"commands-1","depth":2},{"value":"use","id":"use","depth":3},{"value":"list","id":"list","depth":3},{"value":"view","id":"view","depth":3},{"value":"desc","id":"desc","depth":3},{"value":"show","id":"show","depth":3},{"value":"sql","id":"sql","depth":3},{"value":"fields","id":"fields","depth":3},{"value":"pull","id":"pull","depth":3},{"value":"push","id":"push","depth":3},{"value":"validate","id":"validate","depth":3},{"value":"Segment YAML Schema","id":"segment-yaml-schema","depth":2},{"value":"Activation Schema","id":"activation-schema","depth":3},{"value":"Important Behaviors","id":"important-behaviors","depth":3},{"value":"Supported Operators","id":"supported-operators","depth":3},{"value":"Comparison Operators","id":"comparison-operators","depth":4},{"value":"List Operators","id":"list-operators","depth":4},{"value":"String Operators","id":"string-operators","depth":4},{"value":"Null Operators","id":"null-operators","depth":4},{"value":"Time Operators","id":"time-operators","depth":4},{"value":"Time Units","id":"time-units","depth":3},{"value":"Negation with not","id":"negation-with-not","depth":3},{"value":"Operator Examples","id":"operator-examples","depth":3},{"value":"Segment Reference Conditions","id":"segment-reference-conditions","depth":3},{"value":"Complex Rule Example","id":"complex-rule-example","depth":3},{"value":"Related Commands","id":"related-commands","depth":2}],"frontmatter":{"seo":{"title":"tdx segment - CDP Segment Management | Treasure Data","description":"Manage CDP segments with YAML files. Pull, push, validate segments and configure activations.","image":"/assets/og-image.ba836864a30434f560a4f7720f8a09019ad30ff828b20c5052ae933ba7121524.d7ef4821.png"}},"lastModified":"2026-05-18T01:25:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/treasure-code/commands/segment","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}