Treasure Data

Treasure Data Realtime Journeys API

The Realtime Journeys API from Treasure Data — 21 operation(s) for realtime journeys.

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 /audiences/{audienceId}/realtime_setting Get an audience's realtime setting · Get realtime setting for the Audience #
Ask an LLM
“Is realtime enabled for my audience, and how is it configured?”
“Which key columns and event tables does an audience's realtime setting use?”
Tell an agent
Show the realtime setting for audience {audienceId}.
Fetch the realtime key columns and event tables configured on audience {audienceId}.
PATCH /audiences/{audienceId}/realtime_setting Update an audience's realtime setting · Update realtime setting for the Audience #
Ask an LLM
“How do I change which event tables feed realtime for an audience?”
“Can I set the external lookup key and batch attributes used in realtime?”
Tell an agent
Update audience {audienceId} realtime: keys {keyColumns}, events {eventTables}, batch attrs {batchAttributes}, lookup key {extLookupKey}.
Point the realtime setting of audience {audienceId} at event tables {eventTables}.
GET /audiences/{audienceId}/realtime_attributes List an audience's realtime attributes · Return a list of Realtime Attributes for the Audience #
Ask an LLM
“What realtime attributes are defined on an audience?”
“Can I filter realtime attributes by name or type and page through them?”
Tell an agent
List the realtime attributes on audience {audienceId}.
Find realtime attributes in audience {audienceId} whose name includes {name_include}.
POST /audiences/{audienceId}/realtime_attributes Create a realtime attribute · Create a Realtime Attribute #
Ask an LLM
“How do I add a new realtime attribute to an audience?”
“What name and identifier does a realtime attribute need?”
Tell an agent
Create a realtime attribute named {name} with identifier {identifier} on audience {audienceId}.
Add realtime attribute {name} to audience {audienceId} described as {description}.
GET /audiences/{audienceId}/realtime_attributes/{realtimeAttributeId} Get a realtime attribute · Return the Realtime Attribute #
Ask an LLM
“How is one specific realtime attribute defined?”
“Can I see the duration and aggregations of a single realtime attribute?”
Tell an agent
Show realtime attribute {realtimeAttributeId} on audience {audienceId}.
Fetch the definition of realtime attribute {realtimeAttributeId} in audience {audienceId}.
PATCH /audiences/{audienceId}/realtime_attributes/{realtimeAttributeId} Update a realtime attribute · Update the Realtime Attribute #
Ask an LLM
“Can I change the time window or aggregations of a realtime attribute?”
“How many items a realtime attribute keeps - can I change that?”
Tell an agent
Set the duration of realtime attribute {realtimeAttributeId} in audience {audienceId} to {duration}.
Change realtime attribute {realtimeAttributeId} in audience {audienceId} to keep at most {maxItems} items.
DELETE /audiences/{audienceId}/realtime_attributes/{realtimeAttributeId} Delete a realtime attribute · Delete the Realtime Attribute #
Ask an LLM
“How do I remove a realtime attribute from an audience?”
“Is deleting a realtime attribute permanent?”
Tell an agent destructive · confirm first
Delete realtime attribute {realtimeAttributeId} from audience {audienceId}.
Remove the unused realtime attribute {realtimeAttributeId} in audience {audienceId}.
POST /audiences/{audienceId}/realtime_imported_attributes/bulk_update Bulk update imported realtime attributes · Bulk update imported attributes #
Ask an LLM
“Can I update many imported attributes for realtime in one call?”
“How do I change which batch columns are imported into realtime at once?”
Tell an agent
Bulk update the imported attributes of audience {audienceId} with columns {columns}.
Replace the imported realtime columns for audience {audienceId} in one bulk update.
GET /audiences/{audienceId}/realtime_key_events List an audience's realtime key events · Return a list of Realtime Key Events for the Audience #
Ask an LLM
“Which realtime key events are defined for an audience?”
“Can I filter key events by name and page through the results?”
Tell an agent
List the realtime key events for audience {audienceId}.
Find key events in audience {audienceId} whose name includes {name_include}.
POST /audiences/{audienceId}/realtime_key_events Create a realtime key event · Create a Realtime Key Event for the Audience #
Ask an LLM
“How do I define a key event that triggers realtime processing?”
“What table and filter rule does a new key event need?”
Tell an agent
Create key event {name} on audience {audienceId} from {databaseName}.{tableName} filtered by {filterRule}.
Add a new realtime key event {name} for audience {audienceId} watching table {tableName} in database {databaseName} with rule {filterRule}.
GET /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId} Get a realtime key event · Return the specified Realtime Key Event #
Ask an LLM
“How is one specific key event defined?”
“Can I see the filter rule of a single realtime key event?”
Tell an agent
Show key event {realtimeKeyEventId} in audience {audienceId}.
Fetch the definition of realtime key event {realtimeKeyEventId} for audience {audienceId}.
PATCH /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId} Edit a realtime key event · Edit the specified Realtime Key Event #
Ask an LLM
“Can I change the source table or filter rule of an existing key event?”
“What must I resend when editing a realtime key event?”
Tell an agent
Edit key event {realtimeKeyEventId} in audience {audienceId}: name {name}, source {databaseName}.{tableName}, rule {filterRule}.
Change the filter rule of existing key event {realtimeKeyEventId} in audience {audienceId} to {filterRule}.
DELETE /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId} Delete a realtime key event · Delete the specified Realtime Key Event #
Ask an LLM
“How do I remove a key event from an audience?”
“Is deleting a realtime key event permanent?”
Tell an agent destructive · confirm first
Delete key event {realtimeKeyEventId} from audience {audienceId}.
Remove the obsolete realtime key event {realtimeKeyEventId} in audience {audienceId}.
GET /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}/columns List columns of a realtime key event · Return a list of columns of the specified Realtime Key Event #
Ask an LLM
“Which columns are available on a particular key event?”
“What fields can I use from a realtime key event's table?”
Tell an agent
List the columns of key event {realtimeKeyEventId} in audience {audienceId}.
Show which fields key event {realtimeKeyEventId} exposes for audience {audienceId}.
GET /audiences/{audienceId}/realtime_event_tables/{database}/{table}/columns List columns of a realtime event table · Return a list of columns of the specified Realtime Event Table #
Ask an LLM
“What columns does an event table in my realtime setting have?”
“Can I inspect the schema of a realtime event table by database and table name?”
Tell an agent
List the columns of event table {database}.{table} for audience {audienceId}.
Show the schema of realtime event table {table} in database {database}, audience {audienceId}.
GET /audiences/{audienceId}/realtime_configuration_versions/current Get the current realtime configuration version · Return the current version for the Audience #
Ask an LLM
“Which realtime configuration version is live for an audience right now?”
“Can I check the current version of an audience's realtime config?”
Tell an agent
Show the current realtime configuration version for audience {audienceId}.
Tell me which realtime config version audience {audienceId} is running.
GET /entities/parent_segments/{parentSegmentId}/realtime_attributes List realtime attributes available to journeys · List available realtime attributes #
Ask an LLM
“Which realtime attributes can I use when building a journey in a parent segment?”
“Can I search the available realtime attributes with a keyword?”
Tell an agent
List the realtime attributes available to journeys in parent segment {parentSegmentId}.
Search available realtime attributes in parent segment {parentSegmentId} for {q}.
POST /entities/realtime_journeys Create a realtime journey · Create a realtime journey #
Ask an LLM
“How do I build a new realtime customer journey?”
“What attributes does a new realtime journey require?”
Tell an agent
Create a realtime journey with attributes {attributes}.
Build a new realtime journey from scratch using {attributes}.
GET /entities/realtime_journeys/{realtimeJourneyId} Get a realtime journey summary · Retrieve summary of specified realtime journey #
Ask an LLM
“What does a particular realtime journey look like?”
“Can I get the summary of one realtime journey by ID?”
Tell an agent
Show the summary of realtime journey {realtimeJourneyId}.
Fetch realtime journey {realtimeJourneyId}.
PATCH /entities/realtime_journeys/{realtimeJourneyId} Update a realtime journey · Update realtime journey entity #
Ask an LLM
“Can I edit an existing realtime journey after creating it?”
“What happens when I save changes to a realtime journey entity?”
Tell an agent
Update realtime journey {realtimeJourneyId}.
Save my edits to the existing realtime journey {realtimeJourneyId}.
DELETE /entities/realtime_journeys/{realtimeJourneyId} Delete a realtime journey · Delete realtime journey entity #
Ask an LLM
“How do I delete a realtime journey entirely?”
“Is deleting a realtime journey permanent?”
Tell an agent destructive · confirm first
Delete realtime journey {realtimeJourneyId}.
Remove the retired realtime journey {realtimeJourneyId}.
POST /entities/realtime_journeys/{realtimeJourneyId}/detail Validate a realtime journey's fields · Validate fields of the realtime journey #
Ask an LLM
“Can I check a realtime journey's fields for errors before saving?”
“How do I validate the configuration of a realtime journey?”
Tell an agent
Validate the fields of realtime journey {realtimeJourneyId}.
Check whether attributes {attributes} are valid for realtime journey {realtimeJourneyId}.
GET /entities/parent_segments/{parentSegmentId}/realtime_journeys List realtime journeys in a parent segment · Retrieve a list of realtime journeys under the Parent Segment #
Ask an LLM
“Which realtime journeys exist under a parent segment?”
“Can I list only the realtime journeys I am allowed to edit?”
Tell an agent
List realtime journeys under parent segment {parentSegmentId}.
List realtime journeys in parent segment {parentSegmentId} where I have {permissions} permission.
GET /entities/parent_segments/{parentSegmentId}/realtime_activations List realtime activations in a parent segment · Retrieve a list of realtime activations under the Parent Segment #
Ask an LLM
“What realtime activations are running across a whole parent segment?”
“Can I page through every realtime activation in a parent segment?”
Tell an agent
List all realtime activations under parent segment {parentSegmentId}.
Show the first {size} realtime activations in parent segment {parentSegmentId}.
GET /entities/realtime_journeys/{realtimeJourneyId}/activations List activations of a realtime journey · Retrieve a list of realtime journey activations for the specified realtime… #
Ask an LLM
“Which activation steps belong to one realtime journey?”
“Can I page through the activations of a single journey?”
Tell an agent
List the activations in realtime journey {realtimeJourneyId}.
Show the first {size} activation steps of journey {realtimeJourneyId}.
POST /entities/realtime_journeys/{realtimeJourneyId}/activations Add an activation to a realtime journey · Create a realtime journey activations for the specified realtime journey #
Ask an LLM
“How do I add an activation step to a realtime journey?”
“What attributes does a new journey activation need?”
Tell an agent
Add an activation to realtime journey {realtimeJourneyId} with attributes {attributes}.
Create a new activation step in journey {realtimeJourneyId} using {attributes}.
GET /entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId} Get an activation node in a realtime journey · Retrieve a summary of the activation node in a realtime journey #
Ask an LLM
“What is configured on one activation node of a journey?”
“Can I get the summary of a single activation step by its ID?”
Tell an agent
Show activation step {realtimeJourneyActivationStepId} in realtime journey {realtimeJourneyId}.
Fetch the summary of activation node {realtimeJourneyActivationStepId} of journey {realtimeJourneyId}.
PATCH /entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId} Update an activation node in a realtime journey · Update activation node in journey #
Ask an LLM
“Can I change the settings of an existing activation step in a journey?”
“What do I send to edit a journey's activation node?”
Tell an agent
Update activation step {realtimeJourneyActivationStepId} in journey {realtimeJourneyId} with {attributes}.
Change the existing activation node {realtimeJourneyActivationStepId} of journey {realtimeJourneyId} to use {attributes}.
PATCH /entities/realtime_journeys/{realtimeJourneyId}/pause Pause a realtime journey's activations · Pause activations in the realtime journey #
Ask an LLM
“How do I temporarily stop a realtime journey from sending activations?”
“Can I pause a journey without deleting it?”
Tell an agent
Pause activations in realtime journey {realtimeJourneyId}.
Put journey {realtimeJourneyId} on hold so it stops activating.
PATCH /entities/realtime_journeys/{realtimeJourneyId}/resume Resume a paused realtime journey · Resume activations in the realtime journey #
Ask an LLM
“How do I restart activations on a journey I paused?”
“Can a paused realtime journey pick up again?”
Tell an agent
Resume activations in paused realtime journey {realtimeJourneyId}.
Turn journey {realtimeJourneyId} back on after the pause.
POST /entities/realtime_journeys/duplicate Duplicate a realtime journey · Create a duplicate of the specified realtime journey #
Ask an LLM
“Can I copy an existing realtime journey as a starting point?”
“What do I need to duplicate a realtime journey?”
Tell an agent
Duplicate realtime journey {id} as type {type} with attributes {attributes} and relationships {relationships}.
Make a copy of journey {id} using {attributes}, {relationships} and type {type}.
GET /entities/realtime_journeys/abtest_variants List A/B test variants in an audience · Retrieve list of abtest variants available in audience #
Ask an LLM
“Which A/B test variants are available for realtime journeys in an audience?”
“Can I see the journey variants I could A/B test against each other?”
Tell an agent
List the A/B test variants available in audience {audience_id}.
Show the viewable realtime journey A/B variants for audience {audience_id}.

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-realtime-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-realtime-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-realtime-journeys-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: cdp-api Realtime 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 (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/treasure-data/refs/heads/main/openapi/treasure-data-realtime-journeys-api-openapi.yml