How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Treasure Data

Treasure Data Journeys API

In Audience Studio, a journey represents a timeline of events that can help you motivate a customer’s behavior about your product. After marketers create journey stages, they can further analyze and refine the stages and activate specific stages for campaigns. _Journeys is a premium feature. Contact your Customer Success Representative for more information._

Documentation Provider Profile APIs.io OpenAPI GitHub

Treasure Data Journeys API is one of 67 APIs that Treasure Data publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Journeys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 32 operations across 25 paths, and defines 94 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 5 base URLs: https://api-cdp.treasuredata.com, https://api-cdp.treasuredata.co.jp, https://api-cdp.eu01.treasuredata.com, https://api-cdp.ap02.treasuredata.com, https://api-cdp.ap03.treasuredata.com.

32 operations 25 paths 94 schemas 2 DELETE17 GET5 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.treasuredata.com/v3/bulk_loads
Authentication
API Key
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Treasure Data Journeys API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (TdApikeyAuth).

Paths & Operations 32

Across 25 paths, the API surfaces 32 operations — 2 DELETE, 17 GET, 5 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Journeys 32

In Audience Studio, a journey represents a timeline of events that can help you motivate a customer’s behavior about your product. After marketers create journey stages, they can…

GET
/entities/journeys
List journeys
2 params → 200
POST
/entities/journeys
Create journey
body → 200
GET
/entities/journeys/{journeyId}
Retrieve summary of specified journey
1 param → 200
PATCH
/entities/journeys/{journeyId}
Update journey entity
1 param body → 200
DELETE
/entities/journeys/{journeyId}
Delete journey entity
1 param → 200
POST
/entities/journeys/{journeyId}/detail
Update meta field
1 param body → 200
POST
/entities/journeys/{journeyId}/available_behaviors_for_step
Retrieve a list of available behavior table of specified step
2 params body → 200
POST
/entities/journeys/{journeyId}/activation_templates_for_step
Retrieve a list of journey activation templates of specified step
2 params body → 200
POST
/entities/journeys/duplicate
Create a duplicate of the specified journey
body → 200
GET
/entities/journeys/{journeyId}/statistics
Retrieve journey statistics
1 param → 200403
POST
/entities/journeys/{journeyId}/run
Trigger on-demand journey workflow execution
runJourney 1 param → 200403404409422
GET
/entities/journeys/{journeyId}/conversion_sankey_charts
Retrieve the list of conversion sankey chart source data
1 param → 200403
GET
/entities/journeys/{journeyId}/activation_sankey_charts
Retrieve the list of activation sankey chart source data
1 param → 200403
GET
/entities/journeys/{journeyId}/customers
Retrieve list of profiles in journey
1 param → 200
GET
/entities/journeys/segment_rules
Retrieve list of segment rules available in audience
1 param → 200
GET
/entities/journeys/{journeyId}/activations
Retrieve list of journey activations in journey
1 param → 200
POST
/entities/journeys/{journeyId}/activations
Create an activation step in journey
1 param body → 200
GET
/entities/journeys/{journeyId}/activations/{journeyActivationStepId}
Retrieve summary of activation node in journey
2 params → 200
PATCH
/entities/journeys/{journeyId}/activations/{journeyActivationStepId}
Update the configuration of the activation step in journey
2 params body → 200
PATCH
/entities/journeys/{journeyId}/pause
Pause journey and associated activations schedules.
1 param → 200
PATCH
/entities/journeys/{journeyId}/resume
Resume journey and associated activations schedules.
1 param → 200
GET
/entities/journeys/{journeyId}/journey_stages/{journeyStageId}/customers
Retrieve list of profiles in the journey stage
2 params → 200
GET
/entities/journey_bundles/{journeyBundleId}
Return the journey bundle information
1 param → 200
PATCH
/entities/journey_bundles/{journeyBundleId}
Update the metadata of the journey bundle
1 param body → 200
DELETE
/entities/journey_bundles/{journeyBundleId}
Delete the journey bundle
1 param → 200
GET
/entities/journey_bundles/{journeyBundleId}/latest
Returns the latest journey in the bundle
1 param → 200
GET
/entities/journey_bundles/{journeyBundleId}/statistics
Return the list of statistics of jouney under the bundle
1 param → 200
GET
/entities/journey_bundles/{journeyBundleId}/conversion_sankey_charts
Return the list of conversion sankey charts of journey under the bundle
1 param → 200
GET
/entities/journey_bundles/{journeyBundleId}/activation_sankey_charts
Return the list of activation sankey charts of journey under the bundle
1 param → 200
GET
/entities/journey_bundles/{journeyBundleId}/activations
Returns the list of activations associated with the journey bundle
1 param → 200
POST
/entities/journey_bundles/{journeyBundleId}/journeys
Create the new journey under the bundle with copying the latest journey
1 param body → 200
GET
/entities/journey_bundles/{journeyBundleId}/journeys_appendable
Validate the journey can be appended to the bundle
1 param → 200400

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are Syndication (26 properties), partial_journey_activation_step.yaml-JourneyActivationParams (24 properties), ActivationTemplateFieldPropertiesLocked (13 properties), JourneyStageStatistic (10 properties). Each schema is shown below with its type and property counts.

partial_journey.yaml-EntitiesJourneyBundleStatisticsJsonApiResponse
object
2 properties
JourneySankeyCharts
array
EntitiesGetJourneySegmentRulesJsonApiResponse
object
1 property 1 required
Execution
JourneyJumpFromJourney
object
3 properties 2 required
EntitiesListJourneyActivationStepJsonApiResponse
object
2 properties 2 required
ActivationTemplateSyndicationBehaviorProperties
object
6 properties
ActivationTemplateIndexJsonApiResponse
object
4 properties
RepeatUnit
string
Setting an activation repetition cycle such as "day" or "week".
RelationshipsFolderJsonApiResource
object
1 property
JourneyStep
objectnull
1 property
EntitiesGetJourneyConversionSankeyChartsJsonApiResponse
object
1 property 1 required
DeprecatedScheduleType
string
Deprecated. Old parameter for setting schedule type. See/Use RepeatUnit instead.
StartAt
stringnull
cdp-api will fill some value for old syndications with ScheduleType is not NoneType. '%Y-%M-%DT%h:%m:%s' is expected.
partial_journey_activation_step.yaml-JourneyActivationParams
object
24 properties 3 required
JourneyWaitStep
object
JourneyAbTestStep
object
7 properties 4 required
ActivationTemplateFieldPropertiesLocked
object
activation template field properties locked
13 properties
SyndicationJsonApiResource
object
4 properties
EntitiesGetJourneyCustomersJsonApiResponse
object
2 properties 2 required
JourneyWaitStepDaysOfTheWeek
object
6 properties 5 required
EntitiesIndexJourneyJsonApiResponse
object
2 properties 2 required
partial_journey.yaml-EntitiesJourneyBundleActivationSankeyChartsJsonApiResponse
object
2 properties
JourneyJsonApiResource
object
4 properties 4 required
JourneyWaitStepConditionPath
object
7 properties 1 required
EntitiesActivationTemplateIndexJsonApiResponse
object
2 properties 2 required
JourneyActivationStepJsonApiResource
object
4 properties 4 required
EntitiesGetJourneyJsonApiResponse
object
2 properties 2 required
UserJsonApiResource
object
3 properties 3 required
JourneyJumpStep
object
3 properties 3 required
JourneyStageDetailJsonApiResource
object
1 property
JourneyStageStatistic
object
10 properties 10 required
RelationshipsUserJsonApiResource
object
1 property
partial_journey.yaml-EntitiesJourneyBundleUpdateRepresentation
object
4 properties
AudienceBehaviorWithVisibilityJsonApiResource
object
3 properties 3 required
EntitiesGetJourneyActivationStepJsonApiResponse
object
2 properties 2 required
JourneySankeyChartLink
object
4 properties 3 required
JourneyDecisionPointBranch
object
4 properties 2 required
JourneyWaitStepDate
object
6 properties 5 required
EntitiesJourneyCreateRepresentation
object
3 properties
partial_journey.yaml-EntitiesJourneyBundleActivationsJsonApiResponse
object
2 properties
JourneyStageStatisticsJsonApiResource
array
JourneyStatisticsHistory
object
6 properties 6 required
ColumnType
string
Type of the column
partial_journey.yaml-EntitiesJourneyBundleNewJourneyAppendableJsonApiResponse
object
JourneySankeyChartNode
object
2 properties 2 required
RelationshipsBatchSegmentJsonApiResource
object
1 property
JourneyEndStep
objectnull
2 properties
JourneyActivationStep
object
4 properties 3 required
JourneyDecisionPointStep
object
3 properties 3 required
partial_journey.yaml-JourneyOnDemandExecutionJsonApiResponse
object
1 property 1 required
JourneyCriteria
objectnull
4 properties 2 required
EntitiesGetJourneyStatisticsJsonApiResponse
object
2 properties 2 required
JourneyMergeStep
object
3 properties 1 required
User
object
3 properties
StringExpression
object
2 properties 1 required
JourneyWaitStepDuration
object
6 properties 5 required
RepeatFrequency
integer
Setting an activation repeat frequency. Currently, it is set only when the repeat unit is "minute". If the repeat unit is "minute", the interval is set in minu…
partial_journey.yaml-JourneyBundleNewJourneyAttributes
object
2 properties
JourneyStageStatisticHistory
object
8 properties 8 required
EntitiesGetJourneyActivationSankeyChartsJsonApiResponse
object
1 property 1 required
partial_journey.yaml-JourneyBundleMetaAttributes
object
3 properties
ColumnExpression
object
3 properties 1 required
SyndicationExecution
JourneyJumpTarget
object
5 properties 2 required
JourneyStatisticsJsonApiResource
object
3 properties 3 required
EntitiesJourneyUpdateRepresentation
object
2 properties
SyndicationBehavior
objectnull
6 properties
ExecutionCore
object
5 properties 5 required
partial_journey.yaml-EntitiesJourneyBundleDestroyJsonApiResponse
object
JourneySegmentRulesJsonApiResource
object
3 properties 3 required
Syndication
object
26 properties
JourneyActivationSankeyCharts
object
1 property
Columns
array
Syndication column detail. Basic syntax is {"column": "aliasname", "source": {...}}. source accepts various definitions. See ColumnExpression/StringExpression…
NullValue
objectnull
1 property
ScheduleType
string
partial_journey.yaml-EntitiesJourneyBundleConversionSankeyChartsJsonApiResponse
object
2 properties
JourneyStageJsonApiResource
object
8 properties 1 required
EntitiesAudienceBehaviorIndexJsonApiResponse
object
1 property 1 required
JourneyWaitStepCondition
object
4 properties 4 required
JsonApiValidationError
object
5 properties 5 required
JourneyProfilesJsonApiResource
object
2 properties 2 required
partial_journey.yaml-JourneyOnDemandExecutionErrorResponse
object
1 property
partial_journey.yaml-EntitiesJourneyBundleNewJourneyNotAppendableJsonApiResponse
object
1 property
partial_journey.yaml-EntitiesJourneyBundleJsonApiResponse
object
8 properties
ActivationTemplateFieldProperties
object
activation template field properties
1 property 1 required
RepeatSubFrequency
array
Parameter for more detailed frequency settings. Values are array of integers. Currently, this parameter is only valid for repeat unit "week". For multiple days…
partial_journey.yaml-JourneyExecutionJsonApiResource
object
3 properties 3 required
JourneySankeyChart
object
1 property
JourneyAbTestVariant
object
6 properties 3 required
AudienceBehaviorSchemaWithVisibility
object
6 properties 3 required
JourneyDuplicateJsonApiResource
object
4 properties 4 required
FunctionExpression
JourneyDetailJsonApiResource
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

treasure-data-journeys-api-openapi.yml Raw ↑

Other APIs Treasure Data publishes across the network.

Treasure Data Bulk Loads API
AE Profile APIs.io
Treasure Data User API
AE Profile APIs.io
Treasure Data System API
AE Profile APIs.io
Treasure Data Postback API
AE Profile APIs.io
Treasure Workflow API
AE Profile APIs.io
Treasure Data Bulk Import API
AE Profile APIs.io
Treasure Data Bulk Loads API
AE Profile APIs.io
Treasure Data Connectors API
AE Profile APIs.io
Treasure Data Databases API
AE Profile APIs.io
Treasure Data Jobs API
AE Profile APIs.io
Treasure Data SSO API
AE Profile APIs.io
Treasure Data System API
AE Profile APIs.io
#Journeys
← Back to T APIs
API Details
ID
treasure-data:treasure-data-journeys-api
Base URL
https://api.treasuredata.com/v3/bulk_loads
Docs
https://docs.treasure.ai/apis/td-api/bulk-loads-api
Provider
Treasure Data
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=treasure-data-journeys-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/treasure-data-journeys-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Treasure Data Journeys API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.