Treasure Data Journeys API

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](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: Journeys
  description: 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. <br><br> _Journeys is a premium feature. Contact your Customer Success Representative for more information._
paths:
  /entities/journeys:
    x-external: true
    get:
      tags:
      - Journeys
      summary: List journeys
      description: List journeys under the specified folder.
      parameters:
      - name: folder_id
        in: query
        description: Folder ID specifying the folder where journeys are listed
        required: true
        schema:
          type: integer
          format: int64
      - name: permission
        in: query
        description: Permission to filter
        required: false
        schema:
          type: string
          enum:
          - view
          - edit
      responses:
        '200':
          description: Returns the list of the journeys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesIndexJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
    post:
      tags:
      - Journeys
      summary: Create journey
      description: Create a journey.
      requestBody:
        description: parameters to create a journey
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              $ref: '#/components/schemas/EntitiesJourneyCreateRepresentation'
            example:
              type: journey
              attributes:
                name: My new journey
                description: ''
                state: draft
                journeyStages:
                - name: stage1
                - name: stage2
              relationships:
                parentFolder:
                  data:
                    id: '688641'
                    type: folder-segment
        required: true
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve summary of specified journey
      description: Retrieve the summary of a specified journey.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
    patch:
      tags:
      - Journeys
      summary: Update journey entity
      description: Update a journey entity.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: parameters to update a journey
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              $ref: '#/components/schemas/EntitiesJourneyUpdateRepresentation'
        required: true
      responses:
        '200':
          description: Returns a summary of the updated journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
    delete:
      tags:
      - Journeys
      summary: Delete journey entity
      description: Delete a journey entity.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Empty if deletion is successful
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/detail:
    x-external: true
    post:
      tags:
      - Journeys
      summary: Update meta field
      description: Update the meta field of the journey in draft.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: parameters to validate a journey
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              $ref: '#/components/schemas/JourneyDetailJsonApiResource'
        required: true
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/available_behaviors_for_step:
    x-external: true
    post:
      tags:
      - Journeys
      summary: Retrieve a list of available behavior table of specified step
      description: Retrieve a list of available behavior table of specified step.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      - name: stepId
        in: query
        schema:
          type: string
          format: uuid
      requestBody:
        description: parameters to retrieve a list of available behavior table
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              $ref: '#/components/schemas/EntitiesJourneyUpdateRepresentation'
        required: true
      responses:
        '200':
          description: Returns a list of available behavior table of specified journey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesAudienceBehaviorIndexJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/activation_templates_for_step:
    x-external: true
    post:
      tags:
      - Journeys
      summary: Retrieve a list of journey activation templates of specified step
      description: Retrieve a list of journey activation templates of specified step.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      - name: stepId
        in: query
        schema:
          type: string
          format: uuid
      requestBody:
        description: parameters to retrieve a list of journey activation templates
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              $ref: '#/components/schemas/EntitiesJourneyUpdateRepresentation'
        required: true
      responses:
        '200':
          description: Returns a list of available behavior table of specified journey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesActivationTemplateIndexJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/duplicate:
    x-external: true
    post:
      tags:
      - Journeys
      summary: Create a duplicate of the specified journey
      description: Create a duplicate of the specified journey
      requestBody:
        description: parameters to duplicate a journey
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              $ref: '#/components/schemas/JourneyDuplicateJsonApiResource'
        required: true
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/statistics:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve journey statistics
      description: Retrieve the specified journey statistics.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the statistical summary of the journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyStatisticsJsonApiResponse'
        '403':
          $ref: '#/components/responses/NonJsonApiForbiddenRequest'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/run:
    x-external: true
    post:
      tags:
      - Journeys
      summary: Trigger on-demand journey workflow execution
      description: 'Triggers the journey workflow to execute immediately using the most recent completed Parent Segment output data. Does not initiate a Parent Segment refresh. Returns 409 Conflict if a PS refresh or journey workflow is already in progress. Returns 422 if the journey is not eligible for on-demand execution (e.g., not active, belongs to Priority Group).

        '
      operationId: runJourney
      parameters:
      - name: journeyId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the journey to trigger
      responses:
        '200':
          description: Journey workflow execution has been triggered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-JourneyOnDemandExecutionJsonApiResponse'
        '403':
          $ref: '#/components/responses/NonJsonApiForbiddenRequest'
        '404':
          description: Journey not found
        '409':
          description: 'Conflict - Parent Segment refresh or journey workflow is already in progress

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-JourneyOnDemandExecutionErrorResponse'
        '422':
          description: 'Journey is not eligible for on-demand execution

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-JourneyOnDemandExecutionErrorResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/conversion_sankey_charts:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve the list of conversion sankey chart source data
      description: Retrieve the list of conversion sankey chart source data
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Retrieve the list of conversion sankey chart source data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyConversionSankeyChartsJsonApiResponse'
        '403':
          $ref: '#/components/responses/NonJsonApiForbiddenRequest'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/activation_sankey_charts:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve the list of activation sankey chart source data
      description: Retrieve the list of activation sankey chart source data
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Retrieve the list of conversion sankey chart source data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyActivationSankeyChartsJsonApiResponse'
        '403':
          $ref: '#/components/responses/NonJsonApiForbiddenRequest'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/customers:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve list of profiles in journey
      description: Retrieve a list of profiles in a journey.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of profiles in the journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyCustomersJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/segment_rules:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve list of segment rules available in audience
      description: Retrieve a list of segment rules available in an audience. It returns the viewable journeys only.
      parameters:
      - name: audience_id
        in: query
        description: Audience the journey belongs to
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of segment rules available in the audience
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneySegmentRulesJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/activations:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve list of journey activations in journey
      description: Retrieve a list of journey activations for the specified journey.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of journey activation step in the journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesListJourneyActivationStepJsonApiResponse'
    post:
      tags:
      - Journeys
      summary: Create an activation step in journey
      description: Create an activation step in a journey.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: parameters to configure the journey activation step
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JourneyActivationStepJsonApiResource'
      responses:
        '200':
          description: Returns a summary of the activation step in the journey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyActivationStepJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/activations/{journeyActivationStepId}:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve summary of activation node in journey
      description: Retrieve a summary of the activation node in a journey.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      - name: journeyActivationStepId
        in: path
        description: JourneyActivationStep ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns a summary of the activation node in the journey
          content:
            application/vnd.treasuredata.v1+json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyActivationStepJsonApiResponse'
      security:
      - TdApikeyAuth: []
    patch:
      tags:
      - Journeys
      summary: Update the configuration of the activation step in journey
      description: Update the configuration of the activation step in journey.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      - name: journeyActivationStepId
        in: path
        description: JourneyActivationStep ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: parameters to edit the journey activation step
        content:
          application/vnd.treasuredata.v1+json:
            schema:
              $ref: '#/components/schemas/JourneyActivationStepJsonApiResource'
      responses:
        '200':
          description: Returns a summary of the activation node in the journey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyActivationStepJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/pause:
    x-external: true
    patch:
      tags:
      - Journeys
      summary: Pause journey and associated activations schedules.
      description: Pause journey and associated activations schedules.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/resume:
    x-external: true
    patch:
      tags:
      - Journeys
      summary: Resume journey and associated activations schedules.
      description: Resume journey and associated activations schedules.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns a summary of the journey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journeys/{journeyId}/journey_stages/{journeyStageId}/customers:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Retrieve list of profiles in the journey stage
      description: Retrieve a list of profiles in a journey stage.
      parameters:
      - name: journeyId
        in: path
        description: Journey ID
        required: true
        schema:
          type: integer
          format: int64
      - name: journeyStageId
        in: path
        description: Journey stage ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of profiles in the journey stage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyProfilesJsonApiResource'
      security:
      - TdApikeyAuth: []
  /entities/journey_bundles/{journeyBundleId}:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Return the journey bundle information
      description: Return the journey bundle information which contains the list of journey versions
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of the journeys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleJsonApiResponse'
      security:
      - TdApikeyAuth: []
    patch:
      tags:
      - Journeys
      summary: Update the metadata of the journey bundle
      description: "Update the editable journey bundle information. The following fields are editable with this API.\n  - name\n  - description\n  - latestJourneyId\nTo update the latest journey, the following validation checks the validity of the operation.\n  - The journey must exist and belong to this journey bundle\n  - The journey must be launched\nThe case when launching new journey as the latest is treated by the POST journey endpoint with the \njourneyBundleId.\n"
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: parameters to edit the name and description of the journey bundle
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleUpdateRepresentation'
        required: true
      responses:
        '200':
          description: Returns the list of the journeys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleJsonApiResponse'
      security:
      - TdApikeyAuth: []
    delete:
      tags:
      - Journeys
      summary: Delete the journey bundle
      description: Delete the journey bundle
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Empty if deletion is successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleDestroyJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journey_bundles/{journeyBundleId}/latest:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Returns the latest journey in the bundle
      description: Returns the latest journey in the bundle
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the latest journey in the bundle
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journey_bundles/{journeyBundleId}/statistics:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Return the list of statistics of jouney under the bundle
      description: Return the statistics under the journey bundle.
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of the journey statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleStatisticsJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journey_bundles/{journeyBundleId}/conversion_sankey_charts:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Return the list of conversion sankey charts of journey under the bundle
      description: Return the list of conversion sankey charts of journey under the bundle
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of the journey statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleConversionSankeyChartsJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journey_bundles/{journeyBundleId}/activation_sankey_charts:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Return the list of activation sankey charts of journey under the bundle
      description: Return the list of activation sankey charts of journey under the bundle
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of the journey statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleActivationSankeyChartsJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journey_bundles/{journeyBundleId}/activations:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Returns the list of activations associated with the journey bundle
      description: Returns the list of activations associated with the journey bundle
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the list of activations associated with the journey bundle
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleActivationsJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journey_bundles/{journeyBundleId}/journeys:
    x-external: true
    post:
      tags:
      - Journeys
      summary: Create the new journey under the bundle with copying the latest journey
      description: Return the journey bundle information which contains the list of journey versions
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: parameters to specify the source journey copy from
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/partial_journey.yaml-JourneyBundleNewJourneyAttributes'
      responses:
        '200':
          description: Returns the journey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesGetJourneyJsonApiResponse'
      security:
      - TdApikeyAuth: []
  /entities/journey_bundles/{journeyBundleId}/journeys_appendable:
    x-external: true
    get:
      tags:
      - Journeys
      summary: Validate the journey can be appended to the bundle
      description: Validate the journey can be appended to the bundle
      parameters:
      - name: journeyBundleId
        in: path
        description: Journey Bundle ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: New journey can be appendable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleNewJourneyAppendableJsonApiResponse'
        '400':
          description: New journey can not be appendable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partial_journey.yaml-EntitiesJourneyBundleNewJourneyNotAppendableJsonApiResponse'
      security:
      - TdApikeyAuth: []
components:
  schemas:
    partial_journey.yaml-EntitiesJourneyBundleStatisticsJsonApiResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JourneyStatisticsJsonApiResource'
        included:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/UserJsonApiResource'
    JourneySankeyCharts:
      type: array
      items:
        $ref: '#/components/schemas/JourneySankeyChart'
    EntitiesGetJourneySegmentRulesJsonApiResponse:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JourneySegmentRulesJsonApiResource'
    Execution:
      allOf:
      - $ref: '#/components/schemas/ExecutionCore'
      - type: object
        required:
        - workflowAttemptId
        properties:
          workflowAttemptId:
            type: string
            pattern: '[1-9][0-9]*'
    JourneyJumpFromJourney:
      type: object
      required:
      - id
      - type
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - journey
          - journeyStage
        attributes:
          type: object
          required:
          - name
          properties:
            name:
              type: string
            jumpType:
              type: string
            jumpName:
              type:
              - string
              - 'null'
            sourceJourneyId:
              type: string
              pattern: '[1-9][0-9]*'
            folderName:
              type: string
            targetJourneyId:
              type: string
              pattern: '[1-9][0-9]*'
            targetStageId:
              type: string
              pattern: '[1-9][0-9]*'
            targetStageName:
              type: string
            deletedBy:
              type:
              - string
              - 'null'
    EntitiesListJourneyActivationStepJsonApiResponse:
      type: object
      required:
      - data
      - included
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JourneyActivationStepJsonApiResource'
        included:
          type: array
          items:
            $ref: '#/components/schemas/UserJsonApiResource'
    ActivationTemplateSyndicationBehaviorProperties:
      type: object
      properties:
        columns:
          $ref: '#/components/schemas/Columns'
        behaviorTableName:
          type: string
          description: Behavior table name which contains behavior records
          example: purchase_history
        joinRow:
          type:
          - integer
          - 'null'
          description: How much rows would be joined (value is N for Top-N join)
          example: 3
        joinStrategy:
          type: string
       

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