Journeys

Operations related to Journeys

Create Journey

Creates Journey.

• This endpoint is in Alpha testing. Please submit any feedback by sending an email to friends@segment.com.

• In order to successfully call this endpoint, the specified Workspace needs to have the Journeys feature enabled. Please reach out to your customer success manager for more information.

Securitytoken

Request

path Parameters

spaceId

required

string [ 1 .. 255 ]

Example: space_id

Request Body schema: application/vnd.segment.v1alpha+json
required

name required	string (name) The name of the journey.
description required	string (description) The description of the journey.
required	object (definition) The journey definition.

Responses

201

Created

404

Resource not found

422

Validation failure

429

Too many requests

post/spaces/{spaceId}/journeys

Request samples

application/vnd.segment.v1alpha+json

{"name": "Journey from API",
"description": "This is a journey created from the API",
"definition": {"entryRules": {"type": "MULTIPLE",
"concurrency": {"enabled": true,
"concurrencyKey": "applicationId"
}
},
"exitRules": {"enabled": true,
"rules": [{"key": {"id": "exitRuleExit_12345"
},
"type": "EXIT_RULE",
"exitType": "EVENT_PERFORMED",
"condition": "event('Credit Card Application Discarded').count() = 1",
"enabled": true,
"concurrencyEnabled": true,
"connectedDestinations": ["destination_5678"
]
},
{"key": {"id": "exitRuleExit_22345"
},
"type": "EXIT_RULE",
"exitType": "AUDIENCE_MEMBERSHIP_CHANGE",
"enabled": true,
"concurrencyEnabled": false,
"audienceId": "aud_12345"
}
],
"relatedDestinations": [{"type": "DESTINATION",
"key": {"id": "destination_5678"
},
"destinations": [{"destinationId": "67644425c7c427181c2dcb6a",
"activations": [{"id": "4R7udgi1oiCH8AooG3mC5",
"eventName": "Credit Card Application Approved in journey",
"actionDefinition": {"id": "ddond619L9vRgb1eAMhuKm",
"name": "Send",
"enabled": true,
"actionId": "ddond619L9vRgb1eAMhuKm",
"mappings": {"url": "https://webhook.site/1920a88d-fd67-429b-ba36-0f421581e67b",
"method": "POST",
"batch_size": 0,
"data": {"@path": "$."
},
"enable_batching": false
}
},
"propertySelections": {"profile": ["phone",
"name",
"whatsapp",
"email"
]
}
}
]
}
]
}
]
},
"initialState": "entry_12345",
"states": [{"key": {"id": "entry_12345"
},
"type": "EVENT_ENTRY",
"transitions": [{"next": "exit_12345"
}
],
"condition": "event('Credit Card Application Discarded').count() = 1"
},
{"key": {"id": "exit_12345"
},
"type": "EXIT"
}
]
}
}

Response samples

application/vnd.segment.v1alpha+json

{"data": {"journey": {"containerId": "jcon_2tG95HZh4oPsgHfcOlznyfcDDAg",
"versionNumber": 1
}
}
}

Get Journey

Returns the journey by containerId

• This endpoint is in Alpha testing. Please submit any feedback by sending an email to friends@segment.com.

• In order to successfully call this endpoint, the specified Workspace needs to have the Journeys feature enabled. Please reach out to your customer success manager for more information.

Securitytoken

Request

path Parameters

spaceId required	string [ 1 .. 255 ] Example: space_id
containerId required	string [ 1 .. 255 ] Example: jcon_2tG95HZh4oPsgHfcOlznyfcDDAg

Responses

200

404

Resource not found

422

Validation failure

429

Too many requests

get/spaces/{spaceId}/journeys/{containerId}

Request samples

TypeScript
Java
Python
Go
curl

import { configureApis, unwrap } from '@segment/public-api-sdk-typescript'

const api = configureApis('/* Insert your Public API token here */')

try {
  const result = await unwrap(api.journeys.getJourney('space_id', 'jcon_2tG95HZh4oPsgHfcOlznyfcDDAg'))
  console.log(JSON.stringify(result))
} catch (e) {
  console.log('ERROR:', e)
}

Response samples

application/vnd.segment.v1alpha+json

{"data": {"journey": {"containerId": "jcon_2tG95HZh4oPsgHfcOlznyfcDDAg",
"name": "Journey from API",
"description": "This is a journey created from the API",
"createdAt": "2006-01-02T15:04:05.000Z",
"updatedAt": "2006-01-02T15:04:05.000Z",
"createdBy": "john doe",
"updatedBy": "john doe",
"version": {"version": 1,
"createdAt": "2006-01-02T15:04:05.000Z",
"createdBy": "john doe",
"id": "jver_2tG95GjGbpWY6ekr2KPQ6vMmlkZ",
"status": "DRAFT",
"definition": {"initialState": "entry_12345",
"exitRules": {"enabled": true,
"rules": [{"key": {"id": "exitRuleExit_12345"
},
"type": "EXIT_RULE",
"exitType": "EVENT_PERFORMED",
"condition": "event('Credit Card Application Discarded').count() = 1",
"enabled": true,
"concurrencyEnabled": true,
"connectedDestinations": ["destination_5678"
]
},
{"key": {"id": "exitRuleExit_22345"
},
"type": "EXIT_RULE",
"exitType": "AUDIENCE_MEMBERSHIP_CHANGE",
"enabled": true,
"concurrencyEnabled": false,
"audienceId": "aud_12345"
}
],
"relatedDestinations": [{"type": "DESTINATION",
"key": {"id": "destination_5678"
},
"destinations": [{"destinationId": "67644425c7c427181c2dcb6a",
"activations": [{"id": "4R7udgi1oiCH8AooG3mC5",
"eventName": "Credit Card Application Approved in journey",
"actionDefinition": {"id": "ddond619L9vRgb1eAMhuKm",
"name": "Send",
"enabled": true,
"actionId": "ddond619L9vRgb1eAMhuKm",
"mappings": {"url": "https://webhook.site/1920a88d-fd67-429b-ba36-0f421581e67b",
"method": "POST",
"batch_size": 0,
"data": {"@path": "$."
},
"enable_batching": false
}
},
"propertySelections": {"profile": ["phone",
"name",
"whatsapp",
"email"
]
}
}
]
}
]
}
]
},
"entryRules": {"type": "MULTIPLE",
"concurrency": {"enabled": true,
"concurrencyKey": "applicationId"
}
},
"states": [{"key": {"id": "exit_12345"
},
"type": "EXIT"
},
{"key": {"id": "exit_22345"
},
"type": "EXIT"
},
{"key": {"id": "entry_12345",
"name": ""
},
"type": "EVENT_ENTRY",
"transitions": [{"next": "split_12345"
}
],
"condition": "event('Credit Card Application Discarded').count() = 1"
},
{"key": {"id": "split_12345",
"name": "wait for event modified"
},
"type": "EVENT_SPLIT",
"transitions": [{"type": "CONDITION",
"next": "destination_12345",
"condition": "event('Credit Card Application Approved').count() = 1"
},
{"type": "TIMEOUT",
"next": "exit_12345",
"duration": "2h"
}
]
},
{"key": {"id": "destination_12345",
"name": "Send to Twilio Omni channel"
},
"type": "DESTINATION",
"transitions": [{"next": "exit_12345"
}
],
"destinations": [{"destinationId": "67644425c7c427181c2dcb6a",
"activations": [{"id": "4R7udgi1oiCH8AooG3mC5",
"eventName": "Credit Card Application Approved in journey",
"actionDefinition": {"id": "ddond619L9vRgb1eAMhuKm",
"name": "Send",
"enabled": true,
"actionId": "ddond619L9vRgb1eAMhuKm",
"mappings": {"url": "https://webhook.site/1920a88d-fd67-429b-ba36-0f421581e67b",
"data": {"@path": "$."
},
"method": "POST",
"batch_size": 0,
"enable_batching": false
}
},
"propertySelections": {"profile": ["phone",
"name",
"whatsapp",
"email"
]
}
}
]
}
]
}
]
},
"updatedAt": "2006-01-02T15:04:05.000Z",
"updatedBy": "john doe"
}
}
}
}

Remove Journey from Space

Delete a journey

• This endpoint is in Alpha testing. Please submit any feedback by sending an email to friends@segment.com.

• In order to successfully call this endpoint, the specified Workspace needs to have the Journeys feature enabled. Please reach out to your customer success manager for more information.

Securitytoken

Request

path Parameters

spaceId required	string [ 1 .. 255 ] Example: spaceId
containerId required	string [ 1 .. 255 ] Example: jcon_2tG95HZh4oPsgHfcOlznyfcDDAg

query Parameters

version

required

number (version)

The journey version.

This parameter exists in alpha.

Example: version=1

Responses

200

404

Resource not found

422

Validation failure

429

Too many requests

delete/spaces/{spaceId}/journeys/{containerId}

Request samples

TypeScript
Java
Python
Go
curl

import { configureApis, unwrap } from '@segment/public-api-sdk-typescript'

const api = configureApis('/* Insert your Public API token here */')

try {
  const result = await unwrap(api.journeys.removeJourneyFromSpace('spaceId', 'jcon_2tG95HZh4oPsgHfcOlznyfcDDAg', 1))
  console.log(JSON.stringify(result))
} catch (e) {
  console.log('ERROR:', e)
}

Response samples

application/vnd.segment.v1alpha+json

{"data": {"status": "SUCCESS"
}
}

Get Journey Analytics

Get Analytics for a journey

• This endpoint is in Alpha testing. Please submit any feedback by sending an email to friends@segment.com.

• In order to successfully call this endpoint, the specified Workspace needs to have the Journeys feature enabled. Please reach out to your customer success manager for more information.

Securitytoken

Request

path Parameters

spaceId required	string [ 1 .. 255 ] Example: spaceId
containerId required	string [ 1 .. 255 ] Example: jcon_2tG95HZh4oPsgHfcOlznyfcDDAg

query Parameters

version required	number (version) The journey version. This parameter exists in alpha. Example: version=1
fromDate required	string (fromDate) This parameter exists in alpha. Example: fromDate=2006-01-02T15:04:05.000Z
toDate	string (toDate) This parameter exists in alpha. Example: toDate=2006-01-02T15:04:05.000Z

Responses

200

404

Resource not found

422

Validation failure

429

Too many requests

get/spaces/{spaceId}/journeys/{containerId}/analytics

Request samples

TypeScript
Java
Python
Go
curl

import { configureApis, unwrap } from '@segment/public-api-sdk-typescript'

const api = configureApis('/* Insert your Public API token here */')

try {
  const result = await unwrap(
    api.journeys.getJourneyAnalytics('spaceId', 'jcon_2tG95HZh4oPsgHfcOlznyfcDDAg', 1, '2006-01-02T15:04:05.000Z')
  )
  console.log(JSON.stringify(result))
} catch (e) {
  console.log('ERROR:', e)
}

Response samples

application/vnd.segment.v1alpha+json

{"data": {"journeyAnalytics": {"topLevelAnalytics": {"entered": {"total": 1000,
"unique": 680
},
"completed": {"total": 800,
"unique": 500
},
"inProgress": {"total": 200,
"unique": 180
},
"exited": {"total": 10,
"unique": 8
}
},
"stepLevelAnalytics": [{"from": {"id": "entry_12345"
},
"to": {"id": "split_12345",
"name": "wait for event"
},
"analytics": {"total": 1000,
"unique": 680
}
},
{"from": {"id": "split_12345",
"name": "wait for event"
},
"to": {"id": "destination_12345",
"name": "Send to Twilio Omni channel"
},
"analytics": {"total": 500,
"unique": 400
}
},
{"from": {"id": "split_12345",
"name": "wait for event"
},
"to": {"id": "exit_12345"
},
"analytics": {"total": 300,
"unique": 100
}
},
{"from": {"id": "destination_12345",
"name": "Send to Twilio Omni channel"
},
"to": {"id": "exit_23456"
},
"analytics": {"total": 500,
"unique": 400
}
}
]
}
}
}

Replace Steps for Journey

Replace steps for a journey

• This endpoint is in Alpha testing. Please submit any feedback by sending an email to friends@segment.com.

• In order to successfully call this endpoint, the specified Workspace needs to have the Journeys feature enabled. Please reach out to your customer success manager for more information.

Securitytoken

Request

path Parameters

spaceId required	string [ 1 .. 255 ] Example: spaceId
containerId required	string [ 1 .. 255 ] Example: jcon_2tG95HZh4oPsgHfcOlznyfcDDAg

Request Body schema: application/vnd.segment.v1alpha+json
required

initialState required	string (initialState) The Initial state of the journey.
required	Array of EventEntryState (object) or AudienceEntryState (object) or ExitState (object) or DestinationState (object) or SimpleDelayState (object) or EventSplitWithTimeoutState (object) or ConditionSplitState (object) or RandomSplitState (object) (states) States of the journey.

Responses

200

404

Resource not found

422

Validation failure

429

Too many requests

put/spaces/{spaceId}/journeys/{containerId}/steps

Request samples

application/vnd.segment.v1alpha+json

{"initialState": "entry_12345",
"states": [{"key": {"id": "exit_12345"
},
"type": "EXIT"
},
{"key": {"id": "exit_22345"
},
"type": "EXIT"
},
{"key": {"id": "entry_12345"
},
"type": "EVENT_ENTRY",
"transitions": [{"next": "split_12345"
}
],
"condition": "event('Credit Card Application Discarded').count() = 1"
},
{"key": {"id": "split_12345",
"name": "wait for event modified"
},
"type": "EVENT_SPLIT",
"transitions": [{"type": "CONDITION",
"next": "destination_12345",
"condition": "event('Credit Card Application Approved').count() = 1"
},
{"type": "TIMEOUT",
"next": "exit_12345",
"duration": "2h"
}
]
},
{"key": {"id": "destination_12345",
"name": "Send to Twilio Omni channel"
},
"type": "DESTINATION",
"transitions": [{"next": "exit_22345"
}
],
"destinations": [ ]
}
]
}

Response samples

application/vnd.segment.v1alpha+json

{"data": {"containerId": "jcon_2tG95HZh4oPsgHfcOlznyfcDDAg",
"versionNumber": 1
}
}

Update Destinations for Journey

Update DESTINATIONS for a journey

• This endpoint is in Alpha testing. Please submit any feedback by sending an email to friends@segment.com.

• In order to successfully call this endpoint, the specified Workspace needs to have the Journeys feature enabled. Please reach out to your customer success manager for more information.

Securitytoken

Request

path Parameters

spaceId required	string [ 1 .. 255 ] Example: spaceId
containerId required	string [ 1 .. 255 ] Example: jcon_2tG95HZh4oPsgHfcOlznyfcDDAg

Request Body schema: application/vnd.segment.v1alpha+json
required

required

Array of objects (stateDestinations)

The updated DESTINATIONS.

Responses

200

404

Resource not found

422

Validation failure

429

Too many requests

patch/spaces/{spaceId}/journeys/{containerId}/destinations

Request samples

application/vnd.segment.v1alpha+json

{"stateDestinations": [{"stateId": "destination_12345",
"destinations": [{"destinationId": "67644425c7c427181c2dcb6a",
"activations": [{"eventName": "Credit Card Application Approved in journey",
"actionDefinition": {"actionId": "ddond619L9vRgb1eAMhuKm",
"useDefaultMappings": true,
"mappings": {"url": "https://webhook.site/1920a88d-fd67-429b-ba36-0f421581e67b"
}
},
"propertySelections": {"profile": ["email",
"name",
"phone",
"whatsapp"
]
}
}
]
}
]
}
]
}

Response samples

application/vnd.segment.v1alpha+json

{"data": {"containerId": "jcon_2tG95HZh4oPsgHfcOlznyfcDDAg",
"destinations": [{"key": {"id": "destination_12345"
},
"type": "DESTINATION",
"destinations": [{"destinationId": "67644425c7c427181c2dcb6a",
"activations": [{"id": "4R7udgi1oiCH8AooG3mC5",
"eventName": "Credit Card Application Approved in journey",
"actionDefinition": {"id": "ddond619L9vRgb1eAMhuKm",
"name": "Send",
"enabled": true,
"actionId": "ddond619L9vRgb1eAMhuKm",
"mappings": {"url": "https://webhook.site/1920a88d-fd67-429b-ba36-0f421581e67b",
"method": "POST",
"batch_size": 0,
"data": {"@path": "$."
},
"enable_batching": false
}
},
"propertySelections": {"profile": ["phone",
"name",
"whatsapp",
"email"
]
}
}
]
}
],
"transitions": [{"next": "exit_12345"
}
]
}
]
}
}

Update Status for Journey

Update status of the journey

• This endpoint is in Alpha testing. Please submit any feedback by sending an email to friends@segment.com.

• In order to successfully call this endpoint, the specified Workspace needs to have the Journeys feature enabled. Please reach out to your customer success manager for more information.

Securitytoken

Request

path Parameters

spaceId required	string [ 1 .. 255 ] Example: spaceId
containerId required	string [ 1 .. 255 ] Example: jcon_2tG95HZh4oPsgHfcOlznyfcDDAg

Request Body schema: application/vnd.segment.v1alpha+json
required

version required	number (version) The journey version.
action required	string (action) The action to perform for the journey. Enum: "ARCHIVE" "PAUSE_ENTRY" "PUBLISH"

Responses

200

404

Resource not found

422

Validation failure

429

Too many requests

patch/spaces/{spaceId}/journeys/{containerId}/status

Request samples

application/vnd.segment.v1alpha+json

{"action": "PUBLISH",
"version": 1
}

Response samples

application/vnd.segment.v1alpha+json

{"data": {"containerId": "jcon_2tG95HZh4oPsgHfcOlznyfcDDAg",
"status": "PUBLISHED",
"version": 1
}
}

➔ Next to Computed Traits

Journeys

Create Journey

path Parameters

Request Body schema: application/vnd.segment.v1alpha+jsonrequired

Get Journey

path Parameters

Remove Journey from Space

path Parameters

query Parameters

Get Journey Analytics

path Parameters

query Parameters

Replace Steps for Journey

path Parameters

Request Body schema: application/vnd.segment.v1alpha+jsonrequired

Update Destinations for Journey

path Parameters

Request Body schema: application/vnd.segment.v1alpha+jsonrequired

Update Status for Journey

path Parameters

Request Body schema: application/vnd.segment.v1alpha+jsonrequired

Request Body schema: application/vnd.segment.v1alpha+json
required

Request Body schema: application/vnd.segment.v1alpha+json
required

Request Body schema: application/vnd.segment.v1alpha+json
required

Request Body schema: application/vnd.segment.v1alpha+json
required