latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Realtime Journeys

Retrieve a list of realtime journeys under the Parent Segment

get/entities/parent_segments/{parentSegmentId}/realtime_journeys

Query parameters

page[size]number

The maximum number of results to return per page

page[after]string

A string to fetch more page. The next value should be present at the pagination.nextPage in the previous response if more pages exist.

permissions'edit' | 'view'

filter by the resource's permission. Default to 'view'

Response

Returns a list of realtime journeys under the Parent Segment

Example response

{
  "data": [
    {
      "attributes": {
        "realtimeJourneyStages": [
          {
            "steps": {
              "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"
          }
        ]
      }
    }
  ]
}