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._

GitHub OpenAPI

Operations 32

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /entities/journeys List journeys in a folder · List journeys #
Ask an LLM
“Which customer journeys are stored in a particular folder?”
“Can I list only the journeys I have a certain permission on within a folder?”
Tell an agent
List the journeys in folder {folder_id}.
List journeys in folder {folder_id} that I have {permission} permission on.
POST /entities/journeys Create a customer journey · Create journey #
Ask an LLM
“What does it take to build a brand-new customer journey from scratch?”
“Can I attach a new journey to a folder when I create it?”
Tell an agent
Create a new journey with attributes {attributes}.
Create a journey with attributes {attributes} linked to {relationships}.
GET /entities/journeys/{journeyId} Get a journey's summary · Retrieve summary of specified journey #
Ask an LLM
“Where can I see the overall summary and setup of one journey?”
“What does a single journey look like when I fetch it by ID?”
Tell an agent
Show me the summary of journey {journeyId}.
Get the definition of journey {journeyId}.
PATCH /entities/journeys/{journeyId} Update a journey · Update journey entity #
Ask an LLM
“Can I rename a journey or change its settings after it is created?”
“Which journey attributes can be edited with a partial update?”
Tell an agent
Update journey {journeyId} with attributes {attributes}.
Patch the settings of journey {journeyId} to {attributes}.
DELETE /entities/journeys/{journeyId} Delete a journey · Delete journey entity #
Ask an LLM
“Can I permanently remove a journey I no longer need?”
“What happens when I delete a single journey entity?”
Tell an agent destructive · confirm first
Delete journey {journeyId}.
Remove the journey {journeyId} entirely.
POST /entities/journeys/{journeyId}/detail Update a draft journey's meta field · Update meta field #
Ask an LLM
“Can I edit the meta details of a journey while it is still a draft?”
“Where do I save the stages and relationships of a draft journey?”
Tell an agent
Update the meta field of draft journey {journeyId} with {attributes} and {relationships}.
Save draft details {attributes} on journey {journeyId}, keeping relationships {relationships}.
POST /entities/journeys/{journeyId}/available_behaviors_for_step List behavior tables available to a journey step · Retrieve a list of available behavior table of specified step #
Ask an LLM
“Which behavior tables can I use in a given step of my journey?”
“What behavior data is available when configuring a journey step?”
Tell an agent
List the behavior tables available for step {stepId} of journey {journeyId}.
Show which behaviors I can pick for a step in journey {journeyId}.
POST /entities/journeys/{journeyId}/activation_templates_for_step List activation templates usable in a journey step · Retrieve a list of journey activation templates of specified step #
Ask an LLM
“Which activation templates can I apply to a step in my journey?”
“Are there saved activation templates available for a particular journey step?”
Tell an agent
List the activation templates available for step {stepId} of journey {journeyId}.
Show the journey activation templates I can use in journey {journeyId}.
POST /entities/journeys/duplicate Duplicate a journey · Create a duplicate of the specified journey #
Ask an LLM
“Can I make a copy of an existing journey to start a new one?”
“Is there a way to clone a journey with all its stages?”
Tell an agent
Duplicate journey {id} as a new journey with attributes {attributes}.
Make a copy of journey {id} of type {type} linked to {relationships} with attributes {attributes}.
GET /entities/journeys/{journeyId}/statistics Get a journey's statistics · Retrieve journey statistics #
Ask an LLM
“How many profiles have entered, converted or exited a specific journey?”
“Where can I find the performance numbers for one journey version?”
Tell an agent
Show the statistics for journey {journeyId}.
Get entry and conversion statistics of journey {journeyId}.
POST /entities/journeys/{journeyId}/run Run a journey workflow on demand · Trigger on-demand journey workflow execution #
Ask an LLM
“How do I make a customer journey run immediately instead of waiting for its schedule?”
“Does triggering a journey on demand refresh the parent segment first?”
Tell an agent
Run journey {journeyId} now.
Trigger an on-demand execution of journey {journeyId} using the latest parent segment output.
GET /entities/journeys/{journeyId}/conversion_sankey_charts Get a journey's conversion sankey chart data · Retrieve the list of conversion sankey chart source data #
Ask an LLM
“Can I get the data behind the conversion flow diagram for a journey?”
“What source data drives the conversion sankey chart of one journey?”
Tell an agent
Get the conversion sankey chart data for journey {journeyId}.
Pull the conversion flow chart source for journey {journeyId}.
GET /entities/journeys/{journeyId}/activation_sankey_charts Get a journey's activation sankey chart data · Retrieve the list of activation sankey chart source data #
Ask an LLM
“Can I get the data behind the activation flow diagram for a journey?”
“What source data drives the activation sankey chart of one journey?”
Tell an agent
Get the activation sankey chart data for journey {journeyId}.
Pull the activation flow chart source for journey {journeyId}.
GET /entities/journeys/{journeyId}/customers List profiles in a journey · Retrieve list of profiles in journey #
Ask an LLM
“Which customer profiles are currently in a journey?”
“Can I see the people who are moving through a whole journey?”
Tell an agent
List the profiles in journey {journeyId}.
Show me every customer in journey {journeyId}.
GET /entities/journeys/segment_rules List journey segment rules in an audience · Retrieve list of segment rules available in audience #
Ask an LLM
“Which journey-based segment rules can I use in a parent segment?”
“What segment rules do my viewable journeys expose for an audience?”
Tell an agent
List the journey segment rules available in audience {audience_id}.
Show segment rules from viewable journeys for parent segment {audience_id}.
GET /entities/journeys/{journeyId}/activations List a journey's activation steps · Retrieve list of journey activations in journey #
Ask an LLM
“What activation steps are configured inside a journey?”
“Which destinations does a journey send profiles to?”
Tell an agent
List the activations in journey {journeyId}.
Show all activation steps of journey {journeyId}.
POST /entities/journeys/{journeyId}/activations Add an activation step to a journey · Create an activation step in journey #
Ask an LLM
“Can I add a new activation step that sends profiles out of a journey?”
“What do I need to create an activation node inside a journey?”
Tell an agent
Create activation step {id} in journey {journeyId} with attributes {attributes} and relationships {relationships}.
Add an activation of type {type} to journey {journeyId} with attributes {attributes}, step {id}, linked to {relationships}.
GET /entities/journeys/{journeyId}/activations/{journeyActivationStepId} Get an activation step in a journey · Retrieve summary of activation node in journey #
Ask an LLM
“How is one particular activation node in my journey configured?”
“Can I look up a single journey activation step by its ID?”
Tell an agent
Show activation step {journeyActivationStepId} in journey {journeyId}.
Get the summary of activation node {journeyActivationStepId} of journey {journeyId}.
PATCH /entities/journeys/{journeyId}/activations/{journeyActivationStepId} Update an activation step in a journey · Update the configuration of the activation step in journey #
Ask an LLM
“Can I change the configuration of an activation step already in a journey?”
“What fields must I send to reconfigure a journey's activation node?”
Tell an agent
Update activation step {journeyActivationStepId} in journey {journeyId} with attributes {attributes}.
Reconfigure journey {journeyId} activation {journeyActivationStepId}: id {id}, type {type}, attributes {attributes}, relationships {relationships}.
PATCH /entities/journeys/{journeyId}/pause Pause a journey and its activation schedules · Pause journey and associated activations schedules #
Ask an LLM
“Can I temporarily stop a journey and its scheduled activations?”
“What pauses all activation schedules tied to a journey?”
Tell an agent
Pause journey {journeyId}.
Pause journey {journeyId} and its activation schedules.
PATCH /entities/journeys/{journeyId}/resume Resume a paused journey · Resume journey and associated activations schedules #
Ask an LLM
“Can I restart a journey I paused earlier?”
“What turns a paused journey's activation schedules back on?”
Tell an agent
Resume journey {journeyId}.
Resume paused journey {journeyId} and its activation schedules.
GET /entities/journeys/{journeyId}/journey_stages/{journeyStageId}/customers List profiles in a journey stage · Retrieve list of profiles in the journey stage #
Ask an LLM
“Which customers are sitting in one specific stage of a journey?”
“Can I list profiles for just a single journey stage?”
Tell an agent
List the profiles in stage {journeyStageId} of journey {journeyId}.
Show customers currently in journey {journeyId} stage {journeyStageId}.
GET /entities/journey_bundles/{journeyBundleId} Get a journey bundle and its versions · Return the journey bundle information #
Ask an LLM
“Which versions of a journey are kept in a journey bundle?”
“Can I see the information for a journey bundle?”
Tell an agent
Show journey bundle {journeyBundleId}.
List the journey versions in bundle {journeyBundleId}.
PATCH /entities/journey_bundles/{journeyBundleId} Update a journey bundle's metadata · Update the metadata of the journey bundle #
Ask an LLM
“Can I rename a journey bundle or change its description?”
“Which journey version does a bundle treat as latest, and can I change it?”
Tell an agent
Update journey bundle {journeyBundleId} with attributes {attributes}.
Set the name and description of journey bundle {journeyBundleId} to {attributes}.
DELETE /entities/journey_bundles/{journeyBundleId} Delete a journey bundle · Delete the journey bundle #
Ask an LLM
“Can I delete a whole journey bundle rather than one journey?”
“What removes a journey bundle with all its versions?”
Tell an agent destructive · confirm first
Delete journey bundle {journeyBundleId}.
Remove the journey bundle {journeyBundleId}.
GET /entities/journey_bundles/{journeyBundleId}/latest Get the latest journey in a bundle · Returns the latest journey in the bundle #
Ask an LLM
“Which journey is the newest version in a bundle?”
“Can I fetch only the most recent journey from a journey bundle?”
Tell an agent
Get the latest journey in bundle {journeyBundleId}.
Show the newest journey version of bundle {journeyBundleId}.
GET /entities/journey_bundles/{journeyBundleId}/statistics Get statistics across a journey bundle · Return the list of statistics of jouney under the bundle #
Ask an LLM
“How are all the journey versions in a bundle performing?”
“Can I compare statistics for every journey under one bundle?”
Tell an agent
Show the statistics for journey bundle {journeyBundleId}.
Get the per-journey statistics under bundle {journeyBundleId}.
GET /entities/journey_bundles/{journeyBundleId}/conversion_sankey_charts Get conversion sankey charts for a journey bundle · Return the list of conversion sankey charts of journey under the bundle #
Ask an LLM
“Is there conversion flow chart data across all versions in a journey bundle?”
“What conversion sankey charts exist for the journeys in a bundle?”
Tell an agent
Get the conversion sankey charts for journey bundle {journeyBundleId}.
List bundle-wide conversion flow charts for bundle {journeyBundleId}.
GET /entities/journey_bundles/{journeyBundleId}/activation_sankey_charts Get activation sankey charts for a journey bundle · Return the list of activation sankey charts of journey under the bundle #
Ask an LLM
“Where do I see how profiles flowed into activations across every version of a bundled journey?”
“What activation sankey charts exist for the journeys in a bundle?”
Tell an agent
Get the activation sankey charts for journey bundle {journeyBundleId}.
List bundle-wide activation flow charts for bundle {journeyBundleId}.
GET /entities/journey_bundles/{journeyBundleId}/activations List activations of a journey bundle · Returns the list of activations associated with the journey bundle #
Ask an LLM
“Which activations are associated with a journey bundle as a whole?”
“Can I see every activation used across a bundle's journey versions?”
Tell an agent
List the activations for journey bundle {journeyBundleId}.
Show activations tied to bundle {journeyBundleId}.
POST /entities/journey_bundles/{journeyBundleId}/journeys Add a new journey version to a bundle · Create the new journey under the bundle with copying the latest journey #
Ask an LLM
“Can I start a new version of a journey by copying the latest one in its bundle?”
“What creates the next journey version inside a bundle?”
Tell an agent
Create a new journey in bundle {journeyBundleId} copied from the latest version.
Add a journey version to bundle {journeyBundleId} copied from journey {sourceId}.
GET /entities/journey_bundles/{journeyBundleId}/journeys_appendable Check whether a journey can be added to a bundle · Validate the journey can be appended to the bundle #
Ask an LLM
“Is a journey bundle currently able to take another journey version?”
“Can I validate before appending a new journey to a bundle?”
Tell an agent
Check whether a new journey can be appended to bundle {journeyBundleId}.
Validate that bundle {journeyBundleId} accepts another journey version.

Documentation

📖
Documentation
https://docs.treasure.ai/apis/td-api
📖
APIReference
https://docs.treasure.ai/apis/td_api_v3-public
📖
GettingStarted
https://docs.treasure.ai/apis/td-api
📖
Documentation
https://docs.treasure.ai/apis/audience-api/overview
📖
APIReference
https://docs.treasure.ai/apis/td_cdp_api-public
📖
GettingStarted
https://docs.treasure.ai/apis/audience-api
📖
Documentation
https://docs.treasure.ai/apis/llm-api
📖
APIReference
https://docs.treasure.ai/apis/llm_api-public
📖
GettingStarted
https://docs.treasure.ai/apis/llm-api
📖
APIReference
https://docs.treasure.ai/apis/dwh_integration_api-public
📖
GettingStarted
https://docs.treasure.ai/apis/dwh-integration-api/quickstart
📖
GettingStarted
https://docs.treasure.ai/apis/p13n-api
📖
GettingStarted
https://docs.treasure.ai/apis/postback-v2/quickstart

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/treasure-data/refs/heads/main/openapi/treasure-data-journeys-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/treasure-data:treasure-data-journeys-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

treasure-data-journeys-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: cdp-api Journeys API
  description: All of the CDP APIs are organized around REST - if you've interacted with a RESTful API already, many of the concepts will be familiar to you. All API calls to CDP API should be made to the following endpoints depending on the region. For historical reasons there are REST API endpoints and JSON:API endpoints. JSON:API endpoints are located under "/entities".
  termsOfService: https://www.treasuredata.com/terms/
  version: 1.0.0
servers:
- url: https://api-cdp.treasuredata.com
- url: https://api-cdp.treasuredata.co.jp
- url: https://api-cdp.eu01.treasuredata.com
- url: https://api-cdp.ap02.treasuredata.com
- url: https://api-cdp.ap03.treasuredata.com
tags:


# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/treasure-data/refs/heads/main/openapi/treasure-data-journeys-api-openapi.yml