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

Treasure Data Realtime Journeys API

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

Treasure Data Realtime 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 Realtime 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 21 paths, and defines 69 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 21 paths 69 schemas 3 DELETE15 GET7 PATCH7 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
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 32

Across 21 paths, the API surfaces 32 operations — 3 DELETE, 15 GET, 7 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Realtime Journeys 32
GET
/audiences/{audienceId}/realtime_setting
Get realtime setting for the Audience
1 param → 200
PATCH
/audiences/{audienceId}/realtime_setting
Update realtime setting for the Audience
1 param body → 200
GET
/audiences/{audienceId}/realtime_attributes
Return a list of Realtime Attributes for the Audience
6 params → 200
POST
/audiences/{audienceId}/realtime_attributes
Create a Realtime Attribute
1 param body → 200
GET
/audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}
Return the Realtime Attribute
2 params → 200
PATCH
/audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}
Update the Realtime Attribute
2 params body → 200
DELETE
/audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}
Delete the Realtime Attribute
2 params → 200
POST
/audiences/{audienceId}/realtime_imported_attributes/bulk_update
Bulk update imported attributes
1 param body → 200
GET
/audiences/{audienceId}/realtime_key_events
Return a list of Realtime Key Events for the Audience
5 params → 200
POST
/audiences/{audienceId}/realtime_key_events
Create a Realtime Key Event for the Audience
1 param body → 200
GET
/audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}
Return the specified Realtime Key Event
2 params → 200
PATCH
/audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}
Edit the specified Realtime Key Event
2 params body → 200
DELETE
/audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}
Delete the specified Realtime Key Event
2 params → 200
GET
/audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}/columns
Return a list of columns of the specified Realtime Key Event
2 params → 200
GET
/audiences/{audienceId}/realtime_event_tables/{database}/{table}/columns
Return a list of columns of the specified Realtime Event Table
3 params → 200
GET
/audiences/{audienceId}/realtime_configuration_versions/current
Return the current version for the Audience
1 param → 200
GET
/entities/parent_segments/{parentSegmentId}/realtime_attributes
List available realtime attributes
6 params → 200
POST
/entities/realtime_journeys
Create a realtime journey
body → 200
GET
/entities/realtime_journeys/{realtimeJourneyId}
Retrieve summary of specified realtime journey
1 param → 200
PATCH
/entities/realtime_journeys/{realtimeJourneyId}
Update realtime journey entity
1 param → 200
DELETE
/entities/realtime_journeys/{realtimeJourneyId}
Delete realtime journey entity
1 param → 200
POST
/entities/realtime_journeys/{realtimeJourneyId}/detail
Validate fields of the realtime journey
1 param body → 200
GET
/entities/parent_segments/{parentSegmentId}/realtime_journeys
Retrieve a list of realtime journeys under the Parent Segment
4 params → 200
GET
/entities/parent_segments/{parentSegmentId}/realtime_activations
Retrieve a list of realtime activations under the Parent Segment
3 params → 200
GET
/entities/realtime_journeys/{realtimeJourneyId}/activations
Retrieve a list of realtime journey activations for the specified realtime journey.
3 params → 200
POST
/entities/realtime_journeys/{realtimeJourneyId}/activations
Create a realtime journey activations for the specified realtime journey.
1 param body → 200
GET
/entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId}
Retrieve a summary of the activation node in a realtime journey.
2 params → 200
PATCH
/entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId}
Update activation node in journey
2 params body → 200
PATCH
/entities/realtime_journeys/{realtimeJourneyId}/pause
Pause activations in the realtime journey.
1 param → 200
PATCH
/entities/realtime_journeys/{realtimeJourneyId}/resume
Resume activations in the realtime journey.
1 param → 200
POST
/entities/realtime_journeys/duplicate
Create a duplicate of the specified realtime journey
body → 200
GET
/entities/realtime_journeys/abtest_variants
Retrieve list of abtest variants available in audience
1 param → 200

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are partial_realtime_journey.yaml-ParentSegmentRealtimeListAttributeAttributes (13 properties), partial_realtime_journey.yaml-ParentSegmentRealtimeSingleAttributeAttributes (12 properties), partial_realtime_journey.yaml-ParentSegmentRealtimeCounterAttributeAttributes (12 properties), partial_realtime_journey.yaml-ParentSegmentRealtimeImportedAttributeAttributes (11 properties). Each schema is shown below with its type and property counts.

partial_realtime_journey.yaml-RealtimeJourneyDetailAttributes
object
3 properties
partial_realtime_journey.yaml-ParentSegmentRealtimeSingleAttributeAttributes
object
12 properties 8 required
partial_realtime_journey.yaml-RealtimeJourneyJumpTarget
objectnull
3 properties 3 required
partial_realtime_journey.yaml-ParentSegmentRealtimeLookupCatalogAttributeAttributes
object
8 properties 7 required
partial_realtime_journey.yaml-RealtimeJourneyReentryMode
string
partial_realtime_journey.yaml-RealtimeABTestVariant
object
5 properties 5 required
RelationshipsFolderJsonApiResource
object
1 property
partial_realtime_journey.yaml-RealtimeListAttributes
partial_realtime_journey.yaml-RealtimeListAttributeActions
array
partial_realtime_journey.yaml-RealtimeJourneyStageAttributes
object
9 properties 1 required
partial_realtime_journey.yaml-RealtimeSettingReadonlyAttributes
object
2 properties 2 required
partial_realtime_journey.yaml-RealtimeJourneyCustomExitCriteria
object
4 properties 4 required
partial_realtime_journey.yaml-RealtimeAttributesBase
object
8 properties 3 required
partial_realtime_journey.yaml-RealtimeKeyEventColumn
object
3 properties 3 required
partial_realtime_journey.yaml-RealtimeJourneyActivationStepReadonlyAttributes
object
2 properties
partial_realtime_journey.yaml-RealtimeEventTable
object
2 properties 2 required
partial_realtime_journey.yaml-RealtimeAttributeDurationSetting
object
2 properties 2 required
partial_realtime_journey.yaml-RealtimeListAttributeAggregation
object
4 properties
partial_realtime_journey.yaml-RealtimeJourneyActivationStepResource
object
3 properties
partial_pagination.yaml-PaginatedResponse
object
2 properties 2 required
partial_realtime_journey.yaml-RealtimeAndBatchIon
object
partial_realtime_journey.yaml-RelationshipsRealtimeJourneyJumpLinksMeta
object
1 property
partial_realtime_journey.yaml-RealtimeSettingAttributes
object
4 properties 4 required
partial_realtime_journey.yaml-RealtimeSetting
partial_realtime_journey.yaml-RealtimeCounterAttributeIncrementSettingConst
object
2 properties 2 required
partial_realtime_journey.yaml-RealtimeJourneyKeyEventCriteria
object
2 properties
partial_realtime_journey.yaml-RealtimeImportedAttributes
ColumnType
string
Type of the column
partial_realtime_journey.yaml-RealtimeJourneyDuplicateJsonApiResource
object
4 properties 4 required
partial_realtime_journey.yaml-RealtimeJourneyResource
object
4 properties
partial_realtime_journey.yaml-RealtimeListAttributeAggregations
array
partial_realtime_journey.yaml-JumpStep
object
4 properties 1 required
partial_realtime_journey.yaml-RealtimeListAttributeFields
array
partial_realtime_journey.yaml-RealtimeSingleAttributes
partial_realtime_journey.yaml-RealtimeLookupCatalogAttributes
partial_realtime_journey.yaml-RealtimeBatchAttribute
object
2 properties 1 required
User
object
3 properties
partial_realtime_journey.yaml-ParentSegmentRealtimeAttributeAttributes
partial_realtime_journey.yaml-RealtimeABTest
object
4 properties 4 required
partial_realtime_journey.yaml-RelationshipsRealtimeJourneyJumpLinkResource
object
2 properties
partial_realtime_journey.yaml-RealtimeKeyEventAttributes
object
4 properties 4 required
partial_realtime_journey.yaml-RealtimeJourneyAttributes
object
7 properties 7 required
partial_realtime_journey.yaml-RealtimeDecisionPointStep
object
2 properties 2 required
partial_realtime_journey.yaml-RealtimeAttributeAttributes
partial_realtime_journey.yaml-EndStep
object
1 property 1 required
partial_realtime_journey.yaml-RealtimeJourneyActivationStepAttributes
object
6 properties 3 required
partial_realtime_journey.yaml-RealtimeDecisionPointBranch
object
6 properties 5 required
partial_realtime_journey.yaml-RealtimeJourneyStageDetailAttributes
object
2 properties 1 required
partial_realtime_journey.yaml-RealtimeJourneyState
string
partial_realtime_journey.yaml-RealtimeCounterAttributeIncrementSetting
partial_realtime_journey.yaml-RealtimeCounterAttributes
partial_realtime_journey.yaml-RealtimeJourneyCriteria
objectnull
5 properties 1 required
partial_realtime_journey.yaml-RealtimeJourneyReadonlyAttributes
object
6 properties 6 required
partial_realtime_journey.yaml-MergeStep
object
2 properties 2 required
partial_realtime_journey.yaml-RealtimeJourneyStep
object
partial_realtime_journey.yaml-RealtimeAttributeBackfillSetting
objectnull
2 properties 2 required
partial_realtime_journey.yaml-RealtimeJourneyWaitStep
object
4 properties 3 required
partial_realtime_journey.yaml-ParentSegmentRealtimeCounterAttributeAttributes
object
12 properties 11 required
partial_realtime_journey.yaml-RealtimeKeyColumn
object
4 properties 1 required
partial_realtime_journey.yaml-RelationshipsRealtimeJourneyJumpFromsMeta
array
partial_realtime_journey.yaml-RealtimeActivationParameters
object
2 properties
partial_realtime_journey.yaml-EntitiesGetRealtimeJourneyABTestVariantsJsonApiResponse
object
1 property 1 required
partial_realtime_journey.yaml-RealtimeJourneyABTestVariantsJsonApiResource
object
3 properties
partial_realtime_journey.yaml-ParentSegmentRealtimeImportedAttributeAttributes
object
11 properties 4 required
partial_realtime_journey.yaml-RealtimeJourneyCriteriaWithTarget
partial_realtime_journey.yaml-RealtimeCounterAttributeIncrementSettingField
object
2 properties 2 required
partial_realtime_journey.yaml-RealtimeJourneyActivationStep
object
3 properties 2 required
partial_realtime_journey.yaml-ParentSegmentRealtimeListAttributeAttributes
object
13 properties 11 required
partial_realtime_journey.yaml-RealtimeJourneyStaleCriteria
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Treasure Data publishes across the network.

Treasure Data Bulk Loads API
Treasure Data User API
Treasure Data System API
Treasure Data Postback API
Treasure Workflow API
Treasure Data Bulk Import API
Treasure Data Bulk Loads API
Treasure Data Connectors API
Treasure Data Databases API
Treasure Data Jobs API
Treasure Data SSO API
Treasure Data System API
Where this information came from

This is an independent, third-party profile of Treasure Data Realtime 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.