Skip to content
API Documents/
/
/
Create a realtime journey

Create a realtime journey

Request

Create a realtime journey.

Security
TdApikeyAuth
Bodyapplication/vnd.treasuredata.v1+jsonrequired

parameters to create a journey

attributesobject(partial_realtime_journey.yaml-RealtimeJourneyAttributes)required
curl -i -X POST \
  https://api-cdp.treasuredata.com/entities/realtime_journeys \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/vnd.treasuredata.v1+json' \
  -d '{
    "attributes": {
      "audienceId": "string",
      "segmentFolderId": "string",
      "name": "string",
      "description": "string",
      "goal": {
        "name": "string",
        "description": "string",
        "keyEventCriteria": {
          "keyEventId": "string",
          "keyEventFilters": {
            "todo": "string"
          }
        },
        "profileCriteria": {},
        "acceptUnknownProfiles": true,
        "target": {
          "realtimeJourneyId": "string",
          "realtimeJourneyStageId": "string",
          "confirmed": true
        }
      },
      "realtimeJourneyStages": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "steps": {
            "property1": {
              "type": "WaitStep",
              "waitStep": 0,
              "waitStepUnit": "minute",
              "next": "string"
            },
            "property2": {
              "type": "WaitStep",
              "waitStep": 0,
              "waitStepUnit": "minute",
              "next": "string"
            },
            "58AB9022-B48D-430A-A879-2E13D08CD2C1": {
              "type": "WaitStep",
              "name": "Wait 1 hour",
              "waitStep": 1,
              "waitStepUnit": "hour",
              "next": "428CA341-3C3E-4D38-8D88-A035CE83A1FF"
            },
            "428CA341-3C3E-4D38-8D88-A035CE83A1FF": {
              "type": "TriggeredActivation",
              "name": "Send mail",
              "journeyActivationStepId": "123"
            }
          },
          "rootStep": "58AB9022-B48D-430A-A879-2E13D08CD2C1",
          "entryCriteria": {
            "name": "string",
            "description": "string",
            "keyEventCriteria": {
              "keyEventId": "string",
              "keyEventFilters": {
                "todo": "string"
              }
            },
            "profileCriteria": {},
            "acceptUnknownProfiles": true
          },
          "milestone": {
            "name": "string",
            "description": "string",
            "keyEventCriteria": {
              "keyEventId": "string",
              "keyEventFilters": {
                "todo": "string"
              }
            },
            "profileCriteria": {},
            "acceptUnknownProfiles": true
          },
          "exitCriterias": [
            {
              "name": "string",
              "unit": "minute",
              "exitAfter": 1
            }
          ],
          "orderIndex": 0
        }
      ],
      "reentryMode": "no_reentry"
    }
  }'

Responses

Returns a summary of the journey

Bodyapplication/json
dataobject(partial_realtime_journey.yaml-RealtimeJourneyResource)
Response
{
  "data": {
    "id": "string",
    "type": "realtime-journey",
    "attributes": { … },
    "relationships": { … }
  }
}