Skip to content

Main Navigation Guide Book Commands SDK Releases

Appearance

Sidebar Navigation

Documentation

← Back to SDK

← Back to Guide

API Reference

Enumerations

ErrorCategory

ErrorCode

LogLevel

Classes

ClaudeAgentClient

CLIClaudeAgentEnvironment

ConnectionSDK

EngageSDK

JobSDK

JourneySDK

LLMSDK

QuerySDK

RawAPI

SDKError

SegmentSDK

TDX

TDXLogger

UserSDK

WorkflowSDK

Interfaces

ActivationResponse

Agent

AttributePreviewResult

AttributeRequest

AudienceFilter

BehaviorPreviewResult

BehaviorRequest

BehaviorSchemaItem

CampaignInfo

Chat

ChatContentEvent

ChatErrorEvent

ChatHistoryResponse

ChatImageEvent

ChatInputEvent

ChatOptions

ChatOutputEvent

ChatReasoningEvent

ChatSessionMetadata

ChatToolCallEvent

ChatToolResultEvent

ClaudeAgentConfig

ClaudeAgentContentEvent

ClaudeAgentEnvironment

ClaudeAgentErrorEvent

ClaudeAgentInputEvent

ClaudeAgentOutputEvent

ClaudeAgentReasoningEvent

ClaudeAgentSessionMetadata

ClaudeAgentStreamEvent

ClaudeAgentThinkingEvent

ClaudeAgentToolCallEvent

ClaudeAgentToolResultEvent

ColumnInfo

Connection

CreateAgentParams

CreateParentSegmentRequest

CreateParentSegmentResponse

CreateProjectParams

CreateSegmentFolderRequest

CreateSegmentFolderResponse

CreateSegmentRequest

CreateSegmentResponse

CustomerGroupAttribute

CustomerGroupBehavior

CustomerGroupBehaviorSchemaItem

CustomerGroupRequest

DatabaseInfo

EmailTemplateInfo

Job

JobInfo

Journey

JourneyBranch

JourneyCriteria

JourneyExecution

JourneyListItem

JourneyStage

JourneyStageStatistics

JourneyStatistics

JourneyStep

JourneyVariant

LLMProject

MasterPreviewResult

ModelInfo

ParentSegment

ParentSegmentField

PreviewColumnInfo

PreviewOptions

PreviewResult

PullFile

PullSegmentsOptions

PullSegmentsResult

PushParentYamlResult

RawAPIRequestOptions

RawAPIResult

ResolvedSegmentPath

SDKConfig

SDKContext

SDKQueryOptions

SegmentCondition

SegmentFolder

SegmentFolderDetails

SegmentLeftValue

SegmentOperator

SegmentResponse

SegmentRule

SegmentTreeNode

TableInfo

UpdateAgentParams

UpdateSegmentRequest

UpdateSegmentResponse

UserInfo

ValidateOptions

Workflow

WorkflowAttempt

WorkflowLogEntry

WorkflowProject

WorkflowSession

WorkflowTask

WorkspaceInfo

Type Aliases

APIType

Campaign

CampaignStatus

CampaignType

ChatEvent

ChatStreamEvent

ClaudeAgentChatEvent

CompleteQueryResult

EmailTemplate

HTTPMethod

JourneyReentryMode

JourneyState

JourneyStepType

JourneyWaitUnit

PreviewProgressCallback

QueryStage

QueryStats

ResourceType

SessionStatus

TDSite

TrinoColumn

Workspace

Variables

DEFAULT_SAMPLE_LIMIT

DEFAULT_TIME_RANGE

LLM_PROXY_ENDPOINTS

SAFE_INTEGRATION_TYPES

TD_DOCS_MCP_SERVER

TDX_SYSTEM_PROMPT

Functions

deduplicateJourneysByBundle

entityToJourneyListItem

errorContains

findAttributeByName

findBehaviorByName

generateAttributeCoverageSQL

generateAttributeSampleSQL

generateAttributeSchemaSQL

generateBehaviorSampleSQL

generateBehaviorSchemaSQL

generateBehaviorStatsSQL

generateEnrichedSQL

generateMasterCountSQL

generateMasterSampleSQL

generateSchemaValidationSQL

getAttributeColumns

getBehaviorColumns

getConsoleUrl

getEndpoint

getErrorCategory

getErrorMessage

getLLMProxyEndpoint

isHttp400Error

isHttp404Error

isRetryableError

parseJourneyState

On this page

SDK API Reference / JourneyState

Type Alias: JourneyState

JourneyState = "draft" | "simulation" | "launched"

Journey state enumeration

Pager

Previous pageJourneyReentryMode

Next pageJourneyStepType

Copyright 2024-present Treasure Data