Skip to content
Last updated

Personalization Studio Commands

Manage Personalization Studio campaigns — web personalization campaigns that deliver targeted content to audiences based on profile attributes.

Backend endpoint

tdx ps p13n requests are served by the Personalization Studio Config API:

SiteEndpoint
us01personalization-studio-config.us01.treasuredata.com
ap01personalization-studio-config.treasuredata.co.jp
eu01personalization-studio-config.eu01.treasuredata.com

Development and staging environments use personalization-studio-config-development.* and personalization-studio-config-staging.* respectively.

Not yet available in ap02 or ap03.

Commands

CommandDescription
listList campaigns for a parent segment

Typical Usage

# Set parent segment context
tdx use --parent-segment "My Audience"

# List campaigns
tdx ps p13n list

# List campaigns with explicit parent segment ID
tdx ps p13n list --parent-segment-id 291115

# List by parent segment name (positional arg)
tdx ps p13n list "My Audience"

# JSON output for scripting
tdx ps p13n list --parent-segment-id 291115 --format json

list

List Personalization Studio campaigns for a parent segment.

tdx ps p13n list [name] [options]

Arguments

ArgumentDescription
nameParent segment name (optional — uses context if omitted)

Options

OptionDescription
--parent-segment-id <id>Filter by parent segment ID (numeric)
--parent-segment <name>Filter by parent segment name (global option)
--format jsonOutput as JSON array
--format jsonlOutput as JSON Lines
--format tsvOutput as TSV

Resolution order

The parent segment is resolved in this priority:

  1. --parent-segment-id <id> (used directly, no lookup)
  2. Positional [name] argument (resolved to ID)
  3. --parent-segment <name> global option (resolved to ID)
  4. Error with usage hint

Output

Human-readable output shows each campaign with status indicator:

✔ Found 3 campaigns

🚀 Summer Sale Campaign  (launched)
   ID: 1 | Jun 1, 2026 – Sep 30, 2026 America/Vancouver

📝 Winter Promo  (draft)
   ID: 2 | Dec 1, 2026 – Jan 15, 2027 UTC

⚠️  Old Homepage Test  (stale)
   ID: 3 | Jan 1, 2025 – Mar 31, 2025 America/Vancouver

Status meanings:

  • launched 🚀 — Campaign is active and serving personalized content
  • draft 📝 — Campaign is configured but not yet launched
  • stale ⚠️ — Campaign was launched but configuration changed since last launch (needs relaunch)

Examples

# List all campaigns for a parent segment by name
tdx ps p13n list "Customer360"

# Use session context (after `tdx use --parent-segment "Customer360"`)
tdx ps p13n list

# Machine-readable output for automation
tdx ps p13n list --parent-segment-id 291115 --format json

# Pipe to jq for filtering
tdx ps p13n list --parent-segment-id 291115 --format json | jq '.[] | select(.status == "stale")'