Treasure Data Realtime Journeys API

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

Operations 32

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

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-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 email required.

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](https://docs.treasuredata.com/display/public/PD/Sites+and+Endpoints#SitesandEndpoints-Endpoints). 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:
- name: Realtime Journeys
paths:
  /audiences/{audienceId}/realtime_setting:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    get:
      tags:
      - Realtime Journeys
      summary: Get realtime setting for the Audience
      description: Get realtime setting for the Audience
      responses:
        '200':
          description: Returns the realtime setting for the Audience
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeSetting'
    patch:
      tags:
      - Realtime Journeys
      summary: Update realtime setting for the Audience
      description: Update realtime setting for the Audience
      requestBody:
        description: parameters to edit the realtime setting
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeSettingAttributes'
        required: true
      responses:
        '200':
          description: Returns the realtime setting for the Audience
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeSetting'
      security:
      - TdApikeyAuth: []
  /audiences/{audienceId}/realtime_attributes:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    get:
      parameters:
      - $ref: '#/components/parameters/partial_pagination.yaml-PageAfter'
      - $ref: '#/components/parameters/partial_pagination.yaml-PageSize'
      - $ref: '#/components/parameters/partial_pagination.yaml-SortedBy'
      - $ref: '#/components/parameters/NameInclude'
      - name: types
        in: query
        required: false
        description: filter by the resource's type
        schema:
          type: string
          description: comma separated types like "types=single,imported"
      tags:
      - Realtime Journeys
      summary: Return a list of Realtime Attributes for the Audience
      description: Return a list of Realtime Attributes for the Audience
      responses:
        '200':
          description: A list of Realtime Attributes for the Audience
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/partial_pagination.yaml-PaginatedResponse'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                        - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeAttributeAttributes'
    post:
      tags:
      - Realtime Journeys
      summary: Create a Realtime Attribute
      description: Create a Realtime Attribute
      responses:
        '200':
          description: Create a Realtime Attribute
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    data:
                      allOf:
                      - type: object
                        properties:
                          id:
                            type: string
                      - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeAttributeAttributes'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeAttributeAttributes'
              - type: object
                properties:
                  name:
                    type: string
                  identifier:
                    type: string
                  description:
                    type:
                    - string
                    - 'null'
      security:
      - TdApikeyAuth: []
  /audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    - name: realtimeAttributeId
      in: path
      description: Realtime Attribute ID
      required: true
      schema:
        type: integer
        format: int64
    get:
      tags:
      - Realtime Journeys
      summary: Return the Realtime Attribute
      description: Return the Realtime Attribute
      responses:
        '200':
          description: Return the Realtime Attribute
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      type: string
                - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeAttributeAttributes'
    patch:
      tags:
      - Realtime Journeys
      summary: Update the Realtime Attribute
      description: Update the Realtime Attribute
      responses:
        '200':
          description: Update the Realtime Attribute
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      type: string
                - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeAttributeAttributes'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  name:
                    type: string
                  description:
                    type:
                    - string
                    - 'null'
                  duration:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeAttributeDurationSetting'
                  fields:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeListAttributeFields'
                  maxItems:
                    type: number
                    format: int64
                  actions:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeListAttributeActions'
                  aggregations:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeListAttributeAggregations'
                  subDurations:
                    type: array
                    items:
                      $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeAttributeDurationSetting'
    delete:
      tags:
      - Realtime Journeys
      summary: Delete the Realtime Attribute
      description: Delete the Realtime Attribute
      responses:
        '200':
          description: Delete the Realtime Attribute
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
      security:
      - TdApikeyAuth: []
  /audiences/{audienceId}/realtime_imported_attributes/bulk_update:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    post:
      tags:
      - Realtime Journeys
      summary: Bulk update imported attributes
      description: Bulk update imported attributes
      responses:
        '200':
          description: Bulk update imported attributes
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                columns:
                  type: array
                  items:
                    type: string
      security:
      - TdApikeyAuth: []
  /audiences/{audienceId}/realtime_key_events:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    get:
      parameters:
      - $ref: '#/components/parameters/partial_pagination.yaml-PageAfter'
      - $ref: '#/components/parameters/partial_pagination.yaml-PageSize'
      - $ref: '#/components/parameters/partial_pagination.yaml-SortedBy'
      - $ref: '#/components/parameters/NameInclude'
      tags:
      - Realtime Journeys
      summary: Return a list of Realtime Key Events for the Audience
      description: Return a list of Realtime Key Events for the Audience
      responses:
        '200':
          description: A list of Realtime Key Events for the Audience
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/partial_pagination.yaml-PaginatedResponse'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                        - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventAttributes'
      security:
      - TdApikeyAuth: []
    post:
      tags:
      - Realtime Journeys
      summary: Create a Realtime Key Event for the Audience
      description: Create a Realtime Key Event for the Audience
      requestBody:
        description: parameters to create a realtime key event
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventAttributes'
        required: true
      responses:
        '200':
          description: A Realtime Key Events for the Audience
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      type: string
                - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventAttributes'
      security:
      - TdApikeyAuth: []
  /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeKeyEventId'
    get:
      tags:
      - Realtime Journeys
      summary: Return the specified Realtime Key Event
      description: Return the specified Realtime Key Event
      responses:
        '200':
          description: The specified Realtime Key Event
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      type: string
                - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventAttributes'
      security:
      - TdApikeyAuth: []
    patch:
      tags:
      - Realtime Journeys
      summary: Edit the specified Realtime Key Event
      description: Edit the specified Realtime Key Event
      requestBody:
        description: parameters to edit the realtime key event
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventAttributes'
        required: true
      responses:
        '200':
          description: A Realtime Key Events for the Audience
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      type: string
                - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventAttributes'
      security:
      - TdApikeyAuth: []
    delete:
      tags:
      - Realtime Journeys
      summary: Delete the specified Realtime Key Event
      description: Delete the specified Realtime Key Event
      responses:
        '200':
          description: A Realtime Key Events for the Audience
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      type: string
                - $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventAttributes'
      security:
      - TdApikeyAuth: []
  /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}/columns:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeKeyEventId'
    get:
      tags:
      - Realtime Journeys
      summary: Return a list of columns of the specified Realtime Key Event
      description: Return a list of columns of the specified Realtime Key Event
      responses:
        '200':
          description: A list of columns of the specified Realtime Key Event
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventColumn'
      security:
      - TdApikeyAuth: []
  /audiences/{audienceId}/realtime_event_tables/{database}/{table}/columns:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    - name: database
      in: path
      description: database name in EventTable of RealtimeSetting
      required: true
      schema:
        type: string
    - name: table
      in: path
      description: table name in EventTable of RealtimeSetting
      required: true
      schema:
        type: string
    get:
      tags:
      - Realtime Journeys
      summary: Return a list of columns of the specified Realtime Event Table
      description: Return a list of columns of the specified Realtime Event Table
      responses:
        '200':
          description: A list of columns of the specified Realtime Event Table
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeKeyEventColumn'
      security:
      - TdApikeyAuth: []
  /audiences/{audienceId}/realtime_configuration_versions/current:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/AudienceId'
    get:
      tags:
      - Realtime Journeys
      summary: Return the current version for the Audience
      description: Return the current version for the Audience
      responses:
        '200':
          description: The current version
          content:
            application/json:
              schema:
                type:
                - object
                - 'null'
                properties:
                  id:
                    type: string
                  audienceId:
                    type: string
                  status:
                    type: string
                    enum:
                    - queueing
                    - queued
                    - finished
                  eventKind:
                    type: string
                  identifier:
                    type: string
      security:
      - TdApikeyAuth: []
  /entities/parent_segments/{parentSegmentId}/realtime_attributes:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/ParentSegmentId'
    get:
      tags:
      - Realtime Journeys
      summary: List available realtime attributes
      description: List available realtime attributes
      parameters:
      - $ref: '#/components/parameters/partial_pagination.yaml-PageSize'
      - $ref: '#/components/parameters/partial_pagination.yaml-PageAfter'
      - $ref: '#/components/parameters/partial_pagination.yaml-SortedBy'
      - name: types
        in: query
        required: false
        description: filter by the resource's type
        schema:
          type: string
          description: comma separated types like "types=single,imported"
      - name: q
        in: query
        required: false
        schema:
          type: string
          description: Returns resources whose name or any of whose sub attribute names match the value.
      responses:
        '200':
          description: Returns a list of available realtime attributes
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/partial_pagination.yaml-PaginatedResponse'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          type:
                            type: string
                            enum:
                            - realtime-attribute
                          attributes:
                            $ref: '#/components/schemas/partial_realtime_journey.yaml-ParentSegmentRealtimeAttributeAttributes'
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys:
    x-external: true
    post:
      tags:
      - Realtime Journeys
      summary: Create a realtime journey
      description: Create a realtime journey.
      requestBody:
        description: parameters to create a journey
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              type: object
              required:
              - attributes
              - relationships
              properties:
                attributes:
                  $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyAttributes'
        required: true
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyResource'
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys/{realtimeJourneyId}:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeJourneyId'
    get:
      tags:
      - Realtime Journeys
      summary: Retrieve summary of specified realtime journey
      description: Retrieve the summary of a specified realtime journey.
      responses:
        '200':
          description: Returns a summary of the realtime journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyResource'
      security:
      - TdApikeyAuth: []
    patch:
      tags:
      - Realtime Journeys
      summary: Update realtime journey entity
      description: Update a realtime journey entity.
      responses:
        '200':
          description: Returns a summary of the updated journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyResource'
      security:
      - TdApikeyAuth: []
    delete:
      tags:
      - Realtime Journeys
      summary: Delete realtime journey entity
      description: Delete a realtime journey entity.
      responses:
        '200':
          description: Empty if deletion is successful
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys/{realtimeJourneyId}/detail:
    parameters:
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeJourneyId'
    x-external: true
    post:
      tags:
      - Realtime Journeys
      summary: Validate fields of the realtime journey
      description: Validate fields of the realtime journey
      requestBody:
        description: parameters to validate
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              type: object
              properties:
                attributes:
                  $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyDetailAttributes'
        required: true
      responses:
        '200':
          description: Returns a summary of the realtime journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyResource'
      security:
      - TdApikeyAuth: []
  /entities/parent_segments/{parentSegmentId}/realtime_journeys:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/ParentSegmentId'
    get:
      tags:
      - Realtime Journeys
      summary: Retrieve a list of realtime journeys under the Parent Segment
      description: Retrieve a list of realtime journeys under the Parent Segment
      parameters:
      - $ref: '#/components/parameters/partial_pagination.yaml-PageSize'
      - $ref: '#/components/parameters/partial_pagination.yaml-PageAfter'
      - name: permissions
        in: query
        description: filter by the resource's permission. Default to 'view'
        required: false
        schema:
          type: string
          enum:
          - edit
          - view
      responses:
        '200':
          description: Returns a list of realtime journeys under the Parent Segment
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/partial_pagination.yaml-PaginatedResponse'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyResource'
      security:
      - TdApikeyAuth: []
  /entities/parent_segments/{parentSegmentId}/realtime_activations:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/ParentSegmentId'
    get:
      tags:
      - Realtime Journeys
      summary: Retrieve a list of realtime activations under the Parent Segment
      description: Retrieve a list of realtime activations under the Parent Segment
      parameters:
      - $ref: '#/components/parameters/partial_pagination.yaml-PageSize'
      - $ref: '#/components/parameters/partial_pagination.yaml-PageAfter'
      responses:
        '200':
          description: Returns a list of realtime activations under the Parent Segment
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/partial_pagination.yaml-PaginatedResponse'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyActivationStepResource'
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys/{realtimeJourneyId}/activations:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeJourneyId'
    get:
      tags:
      - Realtime Journeys
      summary: Retrieve a list of realtime journey activations for the specified realtime journey.
      description: Retrieve a list of realtime journey activations for the specified realtime journey.
      parameters:
      - $ref: '#/components/parameters/partial_pagination.yaml-PageSize'
      - $ref: '#/components/parameters/partial_pagination.yaml-PageAfter'
      responses:
        '200':
          description: Returns the list of realtime journey activations for the specified realtime journey.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/partial_pagination.yaml-PaginatedResponse'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyActivationStepResource'
      security:
      - TdApikeyAuth: []
    post:
      tags:
      - Realtime Journeys
      summary: Create a realtime journey activations for the specified realtime journey.
      description: Create a realtime journey activations for the specified realtime journey.
      requestBody:
        description: parameters to create a journey
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              type: object
              properties:
                attributes:
                  $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyActivationStepAttributes'
              required:
              - attributes
              additionalProperties: false
      responses:
        '200':
          description: Returns the list of realtime journey activations for the specified realtime journey.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyActivationStepResource'
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId}:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeJourneyId'
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeJourneyActivationStepId'
    get:
      tags:
      - Realtime Journeys
      summary: Retrieve a summary of the activation node in a realtime journey.
      description: Retrieve a summary of the activation node in a realtime journey.
      responses:
        '200':
          description: Returns a summary of the activation node in the journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyActivationStepResource'
      security:
      - TdApikeyAuth: []
    patch:
      tags:
      - Realtime Journeys
      summary: Update activation node in journey
      description: Update the activation node in a journey.
      requestBody:
        description: parameters to create a journey
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              type: object
              properties:
                attributes:
                  $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyActivationStepAttributes'
              required:
              - attributes
              additionalProperties: false
      responses:
        '200':
          description: Returns a summary of the activation node in the journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyActivationStepResource'
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys/{realtimeJourneyId}/pause:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeJourneyId'
    patch:
      tags:
      - Realtime Journeys
      summary: Pause activations in the realtime journey.
      description: Pause activations in the realtime journey.
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyResource'
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys/{realtimeJourneyId}/resume:
    x-external: true
    parameters:
    - $ref: '#/components/parameters/partial_realtime_journey.yaml-RealtimeJourneyId'
    patch:
      tags:
      - Realtime Journeys
      summary: Resume activations in the realtime journey.
      description: Resume activations in the realtime journey.
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyResource'
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys/duplicate:
    x-external: true
    post:
      tags:
      - Realtime Journeys
      summary: Create a duplicate of the specified realtime journey
      description: Create a duplicate of the specified realtime journey
      requestBody:
        description: parameters to duplicate a realtime journey
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyDuplicateJsonApiResource'
        required: true
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/partial_realtime_journey.yaml-RealtimeJourneyResource'
      security:
      - TdApikeyAuth: []
  /entities/realtime_journeys/abtest_variants:
    x-external: true
    get:
      tags:
      - Realtime Journeys
      summary: Retrieve list of abtest variants available in audience
      description: Retrieve a list of abtest variants available in an audience. It returns the viewable realtime journeys only.
      parameters:
      - name: audience_id
        in: query
        description: Audience the realtime journey belongs to
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of abtest variants available in the audience
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_realtime_journey.yaml-EntitiesGetRealtimeJourneyABTestVariantsJsonApiResponse'
      security:
      - TdApikeyAuth: []
components:
  parameters:
    partial_pagination.yaml-PageAfter:
      name: page[after]
      in: query
      description: A string to fetch more page. The next value should be present at the pagination.nextPage in the previous response if more pages exist.
      required: false
      schema:
        type: string
    partial_realtime_journey.yaml-RealtimeJourneyActivationStepId:
      name: realtimeJourneyActivationStepId
      in: path
      description: Realtime JourneyActivationStep ID
      required: true
      schema:
        type: integer
        format: int64
    ParentSegmentId:
      name: parentSe

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