> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# genesys-journey
> Genesys Journey - customer journey sessions, segments, action maps, outcomes, and predictive analytics
**Server path:** `/genesys-journey` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| [`genesys_journey_delete_actionmap`](#genesys_journey_delete_actionmap) | Delete single action map. |
| [`genesys_journey_delete_actiontemplate`](#genesys_journey_delete_actiontemplate) | Delete a single action template. |
| [`genesys_journey_delete_outcome`](#genesys_journey_delete_outcome) | Delete an outcome. |
| [`genesys_journey_delete_outcomes_predictor`](#genesys_journey_delete_outcomes_predictor) | Delete an outcome predictor. |
| [`genesys_journey_delete_segment`](#genesys_journey_delete_segment) | Delete a segment. |
| [`genesys_journey_delete_view`](#genesys_journey_delete_view) | Delete a Journey View by ID |
| [`genesys_journey_delete_view_schedules`](#genesys_journey_delete_view_schedules) | Delete the Schedule of a JourneyView |
| [`genesys_journey_get_actionmap`](#genesys_journey_get_actionmap) | Retrieve a single action map. |
| [`genesys_journey_get_actionmaps`](#genesys_journey_get_actionmaps) | Retrieve all action maps. |
| [`genesys_journey_get_actionmaps_estimates_job`](#genesys_journey_get_actionmaps_estimates_job) | Get status of job. |
| [`genesys_journey_get_actionmaps_estimates_job_results`](#genesys_journey_get_actionmaps_estimates_job_results) | Get estimates from completed job. |
| [`genesys_journey_get_actiontarget`](#genesys_journey_get_actiontarget) | Retrieve a single action target. |
| [`genesys_journey_get_actiontargets`](#genesys_journey_get_actiontargets) | Retrieve all action targets. |
| [`genesys_journey_get_actiontemplate`](#genesys_journey_get_actiontemplate) | Retrieve a single action template. |
| [`genesys_journey_get_actiontemplates`](#genesys_journey_get_actiontemplates) | Retrieve all action templates. |
| [`genesys_journey_get_deployment_customer_ping`](#genesys_journey_get_deployment_customer_ping) | Send a ping. |
| [`genesys_journey_get_outcome`](#genesys_journey_get_outcome) | Retrieve a single outcome. |
| [`genesys_journey_get_outcomes`](#genesys_journey_get_outcomes) | Retrieve all outcomes. |
| [`genesys_journey_get_outcomes_predictor`](#genesys_journey_get_outcomes_predictor) | Retrieve a single outcome predictor. |
| [`genesys_journey_get_outcomes_predictors`](#genesys_journey_get_outcomes_predictors) | Retrieve all outcome predictors. |
| [`genesys_journey_get_segment`](#genesys_journey_get_segment) | Retrieve a single segment. |
| [`genesys_journey_get_segments`](#genesys_journey_get_segments) | Retrieve all segments. |
| [`genesys_journey_get_session`](#genesys_journey_get_session) | Retrieve a single session. |
| [`genesys_journey_get_session_events`](#genesys_journey_get_session_events) | Retrieve all events for a given session. |
| [`genesys_journey_get_session_outcomescores`](#genesys_journey_get_session_outcomescores) | Retrieve latest outcome score associated with a session for all outcomes. |
| [`genesys_journey_get_view`](#genesys_journey_get_view) | Get a Journey View by ID |
| [`genesys_journey_get_view_schedules`](#genesys_journey_get_view_schedules) | Get the Schedule for a JourneyView |
| [`genesys_journey_get_view_version`](#genesys_journey_get_view_version) | Get a Journey View by ID and version |
| [`genesys_journey_get_view_version_chart`](#genesys_journey_get_view_version_chart) | Get a Chart by ID |
| [`genesys_journey_get_view_version_chart_version`](#genesys_journey_get_view_version_chart_version) | Get a Chart by ID and version |
| [`genesys_journey_get_view_version_job`](#genesys_journey_get_view_version_job) | Get the job for a journey view version. |
| [`genesys_journey_get_view_version_job_results`](#genesys_journey_get_view_version_job_results) | Get the result of a job for a journey view version. |
| [`genesys_journey_get_view_version_job_results_chart`](#genesys_journey_get_view_version_job_results_chart) | Get the chart result associated with a journey view job. |
| [`genesys_journey_get_view_version_jobs_latest`](#genesys_journey_get_view_version_jobs_latest) | Get the latest job of a journey view version. |
| [`genesys_journey_get_views`](#genesys_journey_get_views) | Get a list of Journey Views |
| [`genesys_journey_get_views_data_details`](#genesys_journey_get_views_data_details) | Get details about the data available for journey queries including oldest and newest event dates |
| [`genesys_journey_get_views_eventdefinition`](#genesys_journey_get_views_eventdefinition) | Get an Event Definition |
| [`genesys_journey_get_views_eventdefinitions`](#genesys_journey_get_views_eventdefinitions) | Get a list of Event Definitions |
| [`genesys_journey_get_views_jobs`](#genesys_journey_get_views_jobs) | Get the jobs for an organization. |
| [`genesys_journey_get_views_jobs_me`](#genesys_journey_get_views_jobs_me) | Get my jobs |
| [`genesys_journey_get_views_schedules`](#genesys_journey_get_views_schedules) | Get the journey schedules for an organization. |
| [`genesys_journey_patch_actionmap`](#genesys_journey_patch_actionmap) | Update single action map. |
| [`genesys_journey_patch_actiontarget`](#genesys_journey_patch_actiontarget) | Update a single action target. |
| [`genesys_journey_patch_actiontemplate`](#genesys_journey_patch_actiontemplate) | Update a single action template. |
| [`genesys_journey_patch_outcome`](#genesys_journey_patch_outcome) | Update an outcome. |
| [`genesys_journey_patch_segment`](#genesys_journey_patch_segment) | Update a segment. |
| [`genesys_journey_patch_view_version_job`](#genesys_journey_patch_view_version_job) | Update the job for a journey view version. Only the status can be changed and only to Cancelled |
| [`genesys_journey_post_actionmaps`](#genesys_journey_post_actionmaps) | Create an action map. |
| [`genesys_journey_post_actionmaps_estimates_jobs`](#genesys_journey_post_actionmaps_estimates_jobs) | Query for estimates |
| [`genesys_journey_post_actiontemplates`](#genesys_journey_post_actiontemplates) | Create a single action template. |
| [`genesys_journey_post_deployment_actionevent`](#genesys_journey_post_deployment_actionevent) | Sends an action event, which is used for changing the state of actions that have been offered to the user. |
| [`genesys_journey_post_deployment_appevents`](#genesys_journey_post_deployment_appevents) | Send a journey app event, used for tracking customer activity on an application. |
| [`genesys_journey_post_deployment_webevents`](#genesys_journey_post_deployment_webevents) | Send a journey web event, used for tracking customer activity on a website. |
| [`genesys_journey_post_flows_paths_query`](#genesys_journey_post_flows_paths_query) | Query for flow paths. |
| [`genesys_journey_post_outcomes`](#genesys_journey_post_outcomes) | Create an outcome. |
| [`genesys_journey_post_outcomes_predictors`](#genesys_journey_post_outcomes_predictors) | Create an outcome predictor. |
| [`genesys_journey_post_segments`](#genesys_journey_post_segments) | Create a segment. |
| [`genesys_journey_post_view_schedules`](#genesys_journey_post_view_schedules) | Add a new Schedule to a JourneyView |
| [`genesys_journey_post_view_version_jobs`](#genesys_journey_post_view_version_jobs) | Submit a job request for a journey view version. |
| [`genesys_journey_post_view_versions`](#genesys_journey_post_view_versions) | Update a Journey View by ID |
| [`genesys_journey_post_views`](#genesys_journey_post_views) | Create a new Journey View |
| [`genesys_journey_post_views_encodings_validate`](#genesys_journey_post_views_encodings_validate) | Validate whether an encoding exist for a label/value combination. |
| [`genesys_journey_put_view_schedules`](#genesys_journey_put_view_schedules) | Update the Schedule for a JourneyView |
| [`genesys_journey_put_view_version`](#genesys_journey_put_view_version) | Update a Journey View by ID and version |
***
## genesys\_journey\_delete\_actionmap
Delete single action map.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------- |
| `actionMapId` | string | Yes | — | ID of the action map. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionMapId": {
"type": "string",
"description": "ID of the action map."
}
},
"required": [
"PCID",
"actionMapId"
]
}
```
***
## genesys\_journey\_delete\_actiontemplate
Delete a single action template.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `actionTemplateId` | string | Yes | — | ID of the action template. |
| `hardDelete` | boolean | No | — | Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionTemplateId": {
"type": "string",
"description": "ID of the action template."
},
"hardDelete": {
"type": "boolean",
"description": "Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default."
}
},
"required": [
"PCID",
"actionTemplateId"
]
}
```
***
## genesys\_journey\_delete\_outcome
Delete an outcome.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------ |
| `outcomeId` | string | Yes | — | ID of the outcome. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"outcomeId": {
"type": "string",
"description": "ID of the outcome."
}
},
"required": [
"PCID",
"outcomeId"
]
}
```
***
## genesys\_journey\_delete\_outcomes\_predictor
Delete an outcome predictor.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------- |
| `predictorId` | string | Yes | — | ID of predictor |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"predictorId": {
"type": "string",
"description": "ID of predictor"
}
},
"required": [
"PCID",
"predictorId"
]
}
```
***
## genesys\_journey\_delete\_segment
Delete a segment.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------ |
| `segmentId` | string | Yes | — | ID of the segment. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"segmentId": {
"type": "string",
"description": "ID of the segment."
}
},
"required": [
"PCID",
"segmentId"
]
}
```
***
## genesys\_journey\_delete\_view
Delete a Journey View by ID
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `viewId` | string | Yes | — | View Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "View Id"
}
},
"required": [
"PCID",
"viewId"
]
}
```
***
## genesys\_journey\_delete\_view\_schedules
Delete the Schedule of a JourneyView
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------- |
| `viewId` | string | Yes | — | Journey View Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
}
},
"required": [
"PCID",
"viewId"
]
}
```
***
## genesys\_journey\_get\_actionmap
Retrieve a single action map.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------- |
| `actionMapId` | string | Yes | — | ID of the action map. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionMapId": {
"type": "string",
"description": "ID of the action map."
}
},
"required": [
"PCID",
"actionMapId"
]
}
```
***
## genesys\_journey\_get\_actionmaps
Retrieve all action maps.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `sortBy` | string | No | — | Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). |
| `filterField` | string | No | — | Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set. |
| `filterValue` | string | No | — | Value to filter by. Requires 'filterValue' to also be set. |
| `actionMapIds` | string\[] | No | — | IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request. |
| `queryFields` | string\[] | No | — | Action Map field(s) to query on. Requires 'queryValue' to also be set. |
| `queryValue` | string | No | — | Value to query on using fuzzy matching. Requires 'queryFields' to also be set. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"sortBy": {
"type": "string",
"description": "Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate)."
},
"filterField": {
"type": "string",
"description": "Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set."
},
"filterValue": {
"type": "string",
"description": "Value to filter by. Requires 'filterValue' to also be set."
},
"actionMapIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request."
},
"queryFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action Map field(s) to query on. Requires 'queryValue' to also be set."
},
"queryValue": {
"type": "string",
"description": "Value to query on using fuzzy matching. Requires 'queryFields' to also be set."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_actionmaps\_estimates\_job
Get status of job.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------- |
| `jobId` | string | Yes | — | ID of the job. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "ID of the job."
}
},
"required": [
"PCID",
"jobId"
]
}
```
***
## genesys\_journey\_get\_actionmaps\_estimates\_job\_results
Get estimates from completed job.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------- |
| `jobId` | string | Yes | — | ID of the job. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "ID of the job."
}
},
"required": [
"PCID",
"jobId"
]
}
```
***
## genesys\_journey\_get\_actiontarget
Retrieve a single action target.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ------------------------ |
| `actionTargetId` | string | Yes | — | ID of the action target. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionTargetId": {
"type": "string",
"description": "ID of the action target."
}
},
"required": [
"PCID",
"actionTargetId"
]
}
```
***
## genesys\_journey\_get\_actiontargets
Retrieve all action targets.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_actiontemplate
Retrieve a single action template.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | -------------------------- |
| `actionTemplateId` | string | Yes | — | ID of the action template. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionTemplateId": {
"type": "string",
"description": "ID of the action template."
}
},
"required": [
"PCID",
"actionTemplateId"
]
}
```
***
## genesys\_journey\_get\_actiontemplates
Retrieve all action templates.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------ |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `sortBy` | string | No | — | Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate). |
| `mediaType` | string | No | — | Media type |
| `state` | string | No | — | Action template state. |
| `queryFields` | string\[] | No | — | ActionTemplate field(s) to query on. Requires 'queryValue' to also be set. |
| `queryValue` | string | No | — | Value to query on using fuzzy matching. Requires 'queryFields' to also be set. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"sortBy": {
"type": "string",
"description": "Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate)."
},
"mediaType": {
"type": "string",
"description": "Media type",
"enum": [
"webchat",
"webMessagingOffer",
"contentOffer",
"integrationAction",
"architectFlow",
"openAction"
]
},
"state": {
"type": "string",
"description": "Action template state.",
"enum": [
"Active",
"Inactive",
"Deleted"
]
},
"queryFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "ActionTemplate field(s) to query on. Requires 'queryValue' to also be set."
},
"queryValue": {
"type": "string",
"description": "Value to query on using fuzzy matching. Requires 'queryFields' to also be set."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_deployment\_customer\_ping
Send a ping.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `deploymentId` | string | Yes | — | The ID of the deployment sending the ping. |
| `customerCookieId` | string | Yes | — | ID of the customer associated with the ping. |
| `dl` | string | No | — | Document Location: 1) Web Page URL if overridden or URL fragment identifier (window\.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions. |
| `dt` | string | No | — | Document Title. A human readable name for the page or screen |
| `appNamespace` | string | No | — | Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions |
| `sessionId` | string | No | — | UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session |
| `sinceLastBeaconMilliseconds` | integer | No | — | How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "The ID of the deployment sending the ping."
},
"customerCookieId": {
"type": "string",
"description": "ID of the customer associated with the ping."
},
"dl": {
"type": "string",
"description": "Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions."
},
"dt": {
"type": "string",
"description": "Document Title. A human readable name for the page or screen"
},
"appNamespace": {
"type": "string",
"description": "Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions"
},
"sessionId": {
"type": "string",
"description": "UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session"
},
"sinceLastBeaconMilliseconds": {
"type": "integer",
"description": "How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings."
}
},
"required": [
"PCID",
"deploymentId",
"customerCookieId"
]
}
```
***
## genesys\_journey\_get\_outcome
Retrieve a single outcome.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------ |
| `outcomeId` | string | Yes | — | ID of the outcome. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"outcomeId": {
"type": "string",
"description": "ID of the outcome."
}
},
"required": [
"PCID",
"outcomeId"
]
}
```
***
## genesys\_journey\_get\_outcomes
Retrieve all outcomes.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `sortBy` | string | No | — | Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). |
| `outcomeIds` | string\[] | No | — | IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request. |
| `queryFields` | string\[] | No | — | Outcome field(s) to query on. Requires 'queryValue' to also be set. |
| `queryValue` | string | No | — | Value to query on using fuzzy matching. Requires 'queryFields' to also be set. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"sortBy": {
"type": "string",
"description": "Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate)."
},
"outcomeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request."
},
"queryFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Outcome field(s) to query on. Requires 'queryValue' to also be set."
},
"queryValue": {
"type": "string",
"description": "Value to query on using fuzzy matching. Requires 'queryFields' to also be set."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_outcomes\_predictor
Retrieve a single outcome predictor.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------- |
| `predictorId` | string | Yes | — | ID of predictor |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"predictorId": {
"type": "string",
"description": "ID of predictor"
}
},
"required": [
"PCID",
"predictorId"
]
}
```
***
## genesys\_journey\_get\_outcomes\_predictors
Retrieve all outcome predictors.
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_segment
Retrieve a single segment.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------ |
| `segmentId` | string | Yes | — | ID of the segment. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"segmentId": {
"type": "string",
"description": "ID of the segment."
}
},
"required": [
"PCID",
"segmentId"
]
}
```
***
## genesys\_journey\_get\_segments
Retrieve all segments.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sortBy` | string | No | — | Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
| `isActive` | boolean | No | — | Determines whether or not to show only active segments. |
| `segmentIds` | string\[] | No | — | IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request. |
| `queryFields` | string\[] | No | — | Segment field(s) to query on. Requires 'queryValue' to also be set. |
| `queryValue` | string | No | — | Value to query on using fuzzy matching. Requires 'queryFields' to also be set. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sortBy": {
"type": "string",
"description": "Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate)."
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"isActive": {
"type": "boolean",
"description": "Determines whether or not to show only active segments."
},
"segmentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request."
},
"queryFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Segment field(s) to query on. Requires 'queryValue' to also be set."
},
"queryValue": {
"type": "string",
"description": "Value to query on using fuzzy matching. Requires 'queryFields' to also be set."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_session
Retrieve a single session.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------ |
| `sessionId` | string | Yes | — | ID of the session. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sessionId": {
"type": "string",
"description": "ID of the session."
}
},
"required": [
"PCID",
"sessionId"
]
}
```
***
## genesys\_journey\_get\_session\_events
Retrieve all events for a given session.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------------------------------------------------- |
| `sessionId` | string | Yes | — | System-generated UUID that represents the session the event is a part of. |
| `pageSize` | string | No | — | Number of entities to return. Maximum of 200. |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `eventType` | string | No | — | A comma separated list of journey event types to include in the results. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sessionId": {
"type": "string",
"description": "System-generated UUID that represents the session the event is a part of."
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"eventType": {
"type": "string",
"description": "A comma separated list of journey event types to include in the results.",
"enum": [
"com.genesys.journey.OutcomeAchievedEvent",
"com.genesys.journey.SegmentAssignmentEvent",
"com.genesys.journey.WebActionEvent",
"com.genesys.journey.WebEvent",
"com.genesys.journey.AppEvent"
]
}
},
"required": [
"PCID",
"sessionId"
]
}
```
***
## genesys\_journey\_get\_session\_outcomescores
Retrieve latest outcome score associated with a session for all outcomes.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------ |
| `sessionId` | string | Yes | — | ID of the session. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sessionId": {
"type": "string",
"description": "ID of the session."
}
},
"required": [
"PCID",
"sessionId"
]
}
```
***
## genesys\_journey\_get\_view
Get a Journey View by ID
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `viewId` | string | Yes | — | View Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "View Id"
}
},
"required": [
"PCID",
"viewId"
]
}
```
***
## genesys\_journey\_get\_view\_schedules
Get the Schedule for a JourneyView
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------- |
| `viewId` | string | Yes | — | Journey View Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
}
},
"required": [
"PCID",
"viewId"
]
}
```
***
## genesys\_journey\_get\_view\_version
Get a Journey View by ID and version
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `viewId` | string | Yes | — | View Id |
| `versionId` | string | Yes | — | Version Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "View Id"
},
"versionId": {
"type": "string",
"description": "Version Id"
}
},
"required": [
"PCID",
"viewId",
"versionId"
]
}
```
***
## genesys\_journey\_get\_view\_version\_chart
Get a Chart by ID
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | -------------------- |
| `viewId` | string | Yes | — | View Id |
| `journeyViewVersion` | string | Yes | — | Journey View Version |
| `chartId` | string | Yes | — | Chart Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "View Id"
},
"journeyViewVersion": {
"type": "string",
"description": "Journey View Version"
},
"chartId": {
"type": "string",
"description": "Chart Id"
}
},
"required": [
"PCID",
"viewId",
"journeyViewVersion",
"chartId"
]
}
```
***
## genesys\_journey\_get\_view\_version\_chart\_version
Get a Chart by ID and version
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | -------------------- |
| `viewId` | string | Yes | — | View Id |
| `journeyViewVersion` | string | Yes | — | Journey View Version |
| `chartId` | string | Yes | — | Chart Id |
| `chartVersion` | string | Yes | — | Chart Version |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "View Id"
},
"journeyViewVersion": {
"type": "string",
"description": "Journey View Version"
},
"chartId": {
"type": "string",
"description": "Chart Id"
},
"chartVersion": {
"type": "string",
"description": "Chart Version"
}
},
"required": [
"PCID",
"viewId",
"journeyViewVersion",
"chartId",
"chartVersion"
]
}
```
***
## genesys\_journey\_get\_view\_version\_job
Get the job for a journey view version.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | -------------------- |
| `viewId` | string | Yes | — | Journey View Id |
| `journeyVersionId` | string | Yes | — | Journey View Version |
| `jobId` | string | Yes | — | Job Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
},
"journeyVersionId": {
"type": "string",
"description": "Journey View Version"
},
"jobId": {
"type": "string",
"description": "Job Id"
}
},
"required": [
"PCID",
"viewId",
"journeyVersionId",
"jobId"
]
}
```
***
## genesys\_journey\_get\_view\_version\_job\_results
Get the result of a job for a journey view version.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | ----------------------- |
| `viewId` | string | Yes | — | JourneyViewResult id |
| `journeyViewVersion` | string | Yes | — | Journey View Version |
| `jobId` | string | Yes | — | Id of the executing job |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "JourneyViewResult id"
},
"journeyViewVersion": {
"type": "string",
"description": "Journey View Version"
},
"jobId": {
"type": "string",
"description": "Id of the executing job"
}
},
"required": [
"PCID",
"viewId",
"journeyViewVersion",
"jobId"
]
}
```
***
## genesys\_journey\_get\_view\_version\_job\_results\_chart
Get the chart result associated with a journey view job.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | -------------------- |
| `viewId` | string | Yes | — | Journey View Id |
| `journeyVersionId` | string | Yes | — | Journey View Version |
| `jobId` | string | Yes | — | Job Id |
| `chartId` | string | Yes | — | Chart Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
},
"journeyVersionId": {
"type": "string",
"description": "Journey View Version"
},
"jobId": {
"type": "string",
"description": "Job Id"
},
"chartId": {
"type": "string",
"description": "Chart Id"
}
},
"required": [
"PCID",
"viewId",
"journeyVersionId",
"jobId",
"chartId"
]
}
```
***
## genesys\_journey\_get\_view\_version\_jobs\_latest
Get the latest job of a journey view version.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | -------------------- |
| `viewId` | string | Yes | — | Journey View Id |
| `journeyVersionId` | string | Yes | — | Journey View Version |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
},
"journeyVersionId": {
"type": "string",
"description": "Journey View Version"
}
},
"required": [
"PCID",
"viewId",
"journeyVersionId"
]
}
```
***
## genesys\_journey\_get\_views
Get a list of Journey Views
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `nameOrCreatedBy` | string | No | — | Journey View Name or Created By |
| `expand` | string | No | — | Parameter to request additional data to return in Journey payload |
| `id` | string | No | — | Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"nameOrCreatedBy": {
"type": "string",
"description": "Journey View Name or Created By"
},
"expand": {
"type": "string",
"description": "Parameter to request additional data to return in Journey payload",
"enum": [
"charts"
]
},
"id": {
"type": "string",
"description": "Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_views\_data\_details
Get details about the data available for journey queries including oldest and newest event dates
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_views\_eventdefinition
Get an Event Definition
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------ | -------- | ------- | ------------------- |
| `eventDefinitionId` | string | Yes | — | Event Definition ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventDefinitionId": {
"type": "string",
"description": "Event Definition ID"
}
},
"required": [
"PCID",
"eventDefinitionId"
]
}
```
***
## genesys\_journey\_get\_views\_eventdefinitions
Get a list of Event Definitions
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_views\_jobs
Get the jobs for an organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------- |
| `pageNumber` | integer | No | — | The number of the page to return |
| `pageSize` | integer | No | — | Max number of entities to return |
| `interval` | string | No | — | An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval. |
| `statuses` | string | No | — | Job statuses to filter for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "The number of the page to return"
},
"pageSize": {
"type": "integer",
"description": "Max number of entities to return"
},
"interval": {
"type": "string",
"description": "An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval."
},
"statuses": {
"type": "string",
"description": "Job statuses to filter for"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_views\_jobs\_me
Get my jobs
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------- |
| `pageNumber` | integer | No | — | The number of the page to return |
| `pageSize` | integer | No | — | Max number of entities to return |
| `interval` | string | No | — | An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval. |
| `statuses` | string | No | — | Job statuses to filter for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "The number of the page to return"
},
"pageSize": {
"type": "integer",
"description": "Max number of entities to return"
},
"interval": {
"type": "string",
"description": "An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval."
},
"statuses": {
"type": "string",
"description": "Job statuses to filter for"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_get\_views\_schedules
Get the journey schedules for an organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------- |
| `pageNumber` | integer | No | — | The number of the page to return |
| `pageSize` | integer | No | — | Max number of entities to return |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "The number of the page to return"
},
"pageSize": {
"type": "integer",
"description": "Max number of entities to return"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_patch\_actionmap
Update single action map.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `actionMapId` | string | Yes | — | ID of the action map. |
| `action` | object | No | — | The action value |
| `actionMapScheduleGroups` | object | No | — | Action Map Schedule Groups |
| `activation` | object | No | — | The activation value |
| `createdDate` | string | No | — | Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `displayName` | string | Yes | — | Display name of the action map. |
| `endDate` | string | No | — | Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `id` | string | No | — | The globally unique identifier for the object. |
| `ignoreFrequencyCap` | boolean | No | — | Override organization-level frequency cap and always offer web engagements from this action map. |
| `isActive` | boolean | No | — | Whether the action map is active. |
| `modifiedDate` | string | No | — | Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `pageUrlConditions` | object\[] | Yes | — | URL conditions that a page must match for web actions to be displayable. |
| `selfUri` | string | No | — | The URI for this object |
| `startDate` | string | No | — | Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `triggerWithEventConditions` | object\[] | No | — | List of event conditions that must be satisfied to trigger the action map. |
| `triggerWithOutcomePercentileConditions` | object\[] | No | — | Deprecated. Percentile conditions for outcomes that must be satisfied to trigger the action map. |
| `triggerWithOutcomeProbabilityConditions` | object\[] | No | — | Deprecated. Probability conditions for outcomes that must be satisfied to trigger the action map. |
| `triggerWithOutcomeQuantileConditions` | object\[] | No | — | Deprecated. Quantile conditions for outcomes that must be satisfied to trigger the action map. Journey Outcomes is being removed. See [https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/](https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/) |
| `triggerWithSegments` | string\[] | Yes | — | Trigger action map if any segment in the list is assigned to a given customer. |
| `version` | integer | No | — | The version of the action map. |
| `weight` | integer | No | — | Weight of the action map with higher number denoting higher weight. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionMapId": {
"type": "string",
"description": "ID of the action map."
},
"action": {
"type": "object",
"description": "The action value",
"properties": {
"mediaType": {
"type": "string",
"description": "Media type of action.",
"enum": [
"webchat",
"webMessagingOffer",
"contentOffer",
"integrationAction",
"architectFlow",
"openAction"
]
},
"actionTemplate": {
"type": "object",
"description": "Action Template"
},
"actionTargetId": {
"type": "string",
"description": "Deprecated. Action target ID."
},
"isPacingEnabled": {
"type": "boolean",
"description": "Deprecated. Whether this action should be throttled."
},
"props": {
"type": "object",
"description": "The props value"
},
"architectFlowFields": {
"type": "object",
"description": "Architect Flow Fields"
},
"webMessagingOfferFields": {
"type": "object",
"description": "Web Messaging Offer Fields"
},
"openActionFields": {
"type": "object",
"description": "Open Action Fields"
}
},
"required": [
"mediaType"
]
},
"actionMapScheduleGroups": {
"type": "object",
"description": "Action Map Schedule Groups",
"properties": {
"actionMapScheduleGroup": {
"type": "object",
"description": "Action Map Schedule Group"
},
"emergencyActionMapScheduleGroup": {
"type": "object",
"description": "Emergency Action Map Schedule Group"
}
},
"required": [
"actionMapScheduleGroup"
]
},
"activation": {
"type": "object",
"description": "The activation value",
"properties": {
"type": {
"type": "string",
"description": "Type of activation."
},
"delayInSeconds": {
"type": "integer",
"description": "Activation delay time amount."
}
},
"required": [
"type"
]
},
"createdDate": {
"type": "string",
"description": "Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"displayName": {
"type": "string",
"description": "Display name of the action map."
},
"endDate": {
"type": "string",
"description": "Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"ignoreFrequencyCap": {
"type": "boolean",
"description": "Override organization-level frequency cap and always offer web engagements from this action map."
},
"isActive": {
"type": "boolean",
"description": "Whether the action map is active."
},
"modifiedDate": {
"type": "string",
"description": "Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"pageUrlConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The URL condition value."
},
"operator": {
"type": "string",
"enum": [
"containsAll",
"containsAny",
"notContainsAll",
"notContainsAny",
"equal",
"notEqual",
"greaterThan",
"greaterThanOrEqual",
"lessThan",
"lessThanOrEqual",
"startsWith",
"endsWith"
],
"description": "The comparison operator."
}
},
"required": [
"operator",
"values"
]
},
"description": "URL conditions that a page must match for web actions to be displayable."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"startDate": {
"type": "string",
"description": "Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"triggerWithEventConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The event key."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The event values."
},
"operator": {
"type": "string",
"enum": [
"containsAll",
"containsAny",
"notContainsAll",
"notContainsAny",
"equal",
"notEqual",
"greaterThan",
"greaterThanOrEqual",
"lessThan",
"lessThanOrEqual",
"startsWith",
"endsWith"
],
"description": "The comparison operator."
},
"streamType": {
"type": "string",
"enum": [
"Web",
"Custom",
"Conversation",
"App"
],
"description": "The stream type for which this condition can be satisfied."
},
"sessionType": {
"type": "string",
"description": "The session type for which this condition can be satisfied."
},
"eventName": {
"type": "string",
"description": "The name of the event for which this condition can be satisfied."
}
},
"required": [
"key",
"sessionType",
"streamType",
"values"
]
},
"description": "List of event conditions that must be satisfied to trigger the action map."
},
"triggerWithOutcomePercentileConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"outcomeId": {
"type": "string",
"description": "The outcome ID."
},
"maximumPercentile": {
"type": "number",
"format": "float",
"description": "Percentile value for the selected outcome, at or above which the action map will trigger."
},
"fallbackPercentile": {
"type": "number",
"format": "float",
"description": "Additional percentile condition, where if set, the action map will trigger if the current outcome percentile is lower or equal to the value."
}
},
"required": [
"maximumPercentile",
"outcomeId"
]
},
"description": "Deprecated. Percentile conditions for outcomes that must be satisfied to trigger the action map."
},
"triggerWithOutcomeProbabilityConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"outcomeId": {
"type": "string",
"description": "The outcome ID."
},
"maximumProbability": {
"type": "number",
"format": "float",
"description": "Probability value for the selected outcome at or above which the action map will trigger."
},
"probability": {
"type": "number",
"format": "float",
"description": "Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."
}
},
"required": [
"maximumProbability",
"outcomeId"
]
},
"description": "Deprecated. Probability conditions for outcomes that must be satisfied to trigger the action map."
},
"triggerWithOutcomeQuantileConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"outcomeId": {
"type": "string",
"description": "The outcome ID."
},
"maxQuantileThreshold": {
"type": "number",
"format": "float",
"description": "This Outcome Quantile Condition is met when sessionMaxQuantile of the OutcomeScore is above this value, (unless fallbackQuantile is set). Range 0.00-1.00"
},
"fallbackQuantileThreshold": {
"type": "number",
"format": "float",
"description": "(Optional) If set, this Condition is met when maxQuantileThreshold is met, AND the current quantile of the OutcomeScore is below this fallbackQuantileThreshold. Range 0.00-1.00"
}
},
"required": [
"maxQuantileThreshold",
"outcomeId"
]
},
"description": "Deprecated. Quantile conditions for outcomes that must be satisfied to trigger the action map. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/"
},
"triggerWithSegments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trigger action map if any segment in the list is assigned to a given customer."
},
"version": {
"type": "integer",
"description": "The version of the action map."
},
"weight": {
"type": "integer",
"description": "Weight of the action map with higher number denoting higher weight."
}
},
"required": [
"PCID",
"actionMapId",
"displayName",
"pageUrlConditions",
"triggerWithSegments"
]
}
```
***
## genesys\_journey\_patch\_actiontarget
Update a single action target.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ------------------------------------------------- |
| `actionTargetId` | string | Yes | — | ID of the action target. |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `serviceLevel` | object | No | — | Service Level |
| `shortAbandonThreshold` | integer | No | — | Indicates the non-default short abandon threshold |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionTargetId": {
"type": "string",
"description": "ID of the action target."
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"serviceLevel": {
"type": "object",
"description": "Service Level",
"properties": {
"percentage": {
"type": "number",
"description": "The desired Service Level. A value between 0 and 1."
},
"durationMs": {
"type": "integer",
"description": "Service Level target in milliseconds."
}
}
},
"shortAbandonThreshold": {
"type": "integer",
"description": "Indicates the non-default short abandon threshold"
}
},
"required": [
"PCID",
"actionTargetId"
]
}
```
***
## genesys\_journey\_patch\_actiontemplate
Update a single action template.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `actionTemplateId` | string | Yes | — | ID of the action template. |
| `contentOffer` | object | No | — | Content Offer |
| `description` | string | No | — | Description of the action template's functionality. |
| `mediaType` | string | No | — | Media type of action described by the action template. |
| `name` | string | Yes | — | Name of the action template. |
| `state` | string | No | — | Whether the action template is currently active, inactive or deleted. |
| `version` | integer | No | — | The version of the action template. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionTemplateId": {
"type": "string",
"description": "ID of the action template."
},
"contentOffer": {
"type": "object",
"description": "Content Offer",
"properties": {
"imageUrl": {
"type": "string",
"description": "URL for image displayed to the customer when displaying content offer."
},
"displayMode": {
"type": "string",
"description": "The display mode of Genesys Widgets when displaying content offer.",
"enum": [
"Modal",
"Overlay",
"Toast"
]
},
"layoutMode": {
"type": "string",
"description": "The layout mode of the text shown to the user when displaying content offer.",
"enum": [
"TextOnly",
"ImageOnly",
"LeftText",
"RightText",
"TopText",
"BottomText"
]
},
"title": {
"type": "string",
"description": "Title used in the header of the content offer."
},
"headline": {
"type": "string",
"description": "Headline displayed above the body text of the content offer."
},
"body": {
"type": "string",
"description": "Body text of the content offer."
},
"callToAction": {
"type": "object",
"description": "Call To Action"
},
"style": {
"type": "object",
"description": "The style value"
},
"imageAltText": {
"type": "string",
"description": "Image description text for accessibility compliance and assistive technology support."
}
}
},
"description": {
"type": "string",
"description": "Description of the action template's functionality."
},
"mediaType": {
"type": "string",
"description": "Media type of action described by the action template.",
"enum": [
"webchat",
"webMessagingOffer",
"contentOffer",
"integrationAction",
"architectFlow",
"openAction"
]
},
"name": {
"type": "string",
"description": "Name of the action template."
},
"state": {
"type": "string",
"description": "Whether the action template is currently active, inactive or deleted.",
"enum": [
"Active",
"Inactive",
"Deleted"
]
},
"version": {
"type": "integer",
"description": "The version of the action template."
}
},
"required": [
"PCID",
"actionTemplateId",
"name"
]
}
```
***
## genesys\_journey\_patch\_outcome
Update an outcome.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | --------------------------------------- |
| `outcomeId` | string | Yes | — | ID of the outcome. |
| `associatedValueField` | object | No | — | Associated Value Field |
| `context` | object | No | — | The context value |
| `description` | string | No | — | A description of the outcome. |
| `displayName` | string | Yes | — | The display name of the outcome. |
| `isActive` | boolean | No | — | Whether or not the outcome is active. |
| `isPositive` | boolean | No | — | Whether or not the outcome is positive. |
| `journey` | object | No | — | The journey value |
| `version` | integer | No | — | The version of the outcome. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"outcomeId": {
"type": "string",
"description": "ID of the outcome."
},
"associatedValueField": {
"type": "object",
"description": "Associated Value Field",
"properties": {
"dataType": {
"type": "string",
"description": "The data type of the value field.",
"enum": [
"Number",
"Integer"
]
},
"name": {
"type": "string",
"description": "The field name for extracting value from event."
}
}
},
"context": {
"type": "object",
"description": "The context value",
"properties": {
"patterns": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of one or more patterns to match."
}
}
},
"description": {
"type": "string",
"description": "A description of the outcome."
},
"displayName": {
"type": "string",
"description": "The display name of the outcome."
},
"isActive": {
"type": "boolean",
"description": "Whether or not the outcome is active."
},
"isPositive": {
"type": "boolean",
"description": "Whether or not the outcome is positive."
},
"journey": {
"type": "object",
"description": "The journey value",
"properties": {
"patterns": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of zero or more patterns to match."
}
}
},
"version": {
"type": "integer",
"description": "The version of the outcome."
}
},
"required": [
"PCID",
"outcomeId",
"displayName"
]
}
```
***
## genesys\_journey\_patch\_segment
Update a segment.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------- |
| `segmentId` | string | Yes | — | ID of the segment. |
| `assignmentExpirationDays` | integer | No | — | Time, in days, from when the segment is assigned until it is automatically unassigned. |
| `color` | string | No | — | The hexadecimal color value of the segment. |
| `context` | object | No | — | The context value |
| `description` | string | No | — | A description of the segment. |
| `displayName` | string | No | — | The display name of the segment. |
| `externalSegment` | object | No | — | External Segment |
| `isActive` | boolean | No | — | Whether or not the segment is active. |
| `journey` | object | No | — | The journey value |
| `shouldDisplayToAgent` | boolean | No | — | Whether or not the segment should be displayed to agent/supervisor users. |
| `version` | integer | No | — | The version of the segment. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"segmentId": {
"type": "string",
"description": "ID of the segment."
},
"assignmentExpirationDays": {
"type": "integer",
"description": "Time, in days, from when the segment is assigned until it is automatically unassigned."
},
"color": {
"type": "string",
"description": "The hexadecimal color value of the segment."
},
"context": {
"type": "object",
"description": "The context value",
"properties": {
"patterns": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of one or more patterns to match."
}
}
},
"description": {
"type": "string",
"description": "A description of the segment."
},
"displayName": {
"type": "string",
"description": "The display name of the segment."
},
"externalSegment": {
"type": "object",
"description": "External Segment",
"properties": {
"name": {
"type": "string",
"description": "Name for the external segment in the system where it originates from."
}
}
},
"isActive": {
"type": "boolean",
"description": "Whether or not the segment is active."
},
"journey": {
"type": "object",
"description": "The journey value",
"properties": {
"patterns": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of zero or more patterns to match."
}
}
},
"shouldDisplayToAgent": {
"type": "boolean",
"description": "Whether or not the segment should be displayed to agent/supervisor users."
},
"version": {
"type": "integer",
"description": "The version of the segment."
}
},
"required": [
"PCID",
"segmentId"
]
}
```
***
## genesys\_journey\_patch\_view\_version\_job
Update the job for a journey view version. Only the status can be changed and only to Cancelled
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `viewId` | string | Yes | — | Journey View Id |
| `journeyVersionId` | string | Yes | — | Journey View Version |
| `jobId` | string | Yes | — | Job Id |
| `dateCompleted` | string | Yes | — | Timestamp of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateCompletionEstimated` | string | Yes | — | Timestamp for the estimated time of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateCreated` | string | Yes | — | Timestamp of execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `estimatedCompletionMargin` | integer | Yes | — | Margin of error of the estimated time of completion |
| `id` | string | No | — | The globally unique identifier for the object. |
| `journeyView` | object | Yes | — | A journey view |
| `selfUri` | string | No | — | The URI for this object |
| `status` | string | Yes | — | The status of the job |
| `userId` | string | Yes | — | Id of the user who submitted the request |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
},
"journeyVersionId": {
"type": "string",
"description": "Journey View Version"
},
"jobId": {
"type": "string",
"description": "Job Id"
},
"dateCompleted": {
"type": "string",
"description": "Timestamp of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateCompletionEstimated": {
"type": "string",
"description": "Timestamp for the estimated time of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateCreated": {
"type": "string",
"description": "Timestamp of execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"estimatedCompletionMargin": {
"type": "integer",
"description": "Margin of error of the estimated time of completion"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"journeyView": {
"type": "object",
"description": "A journey view",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "A description of the journey view"
},
"version": {
"type": "integer",
"description": "The version of the journey view"
},
"createdBy": {
"type": "object",
"description": "Created By"
},
"modifiedBy": {
"type": "object",
"description": "Modified By"
},
"interval": {
"type": "string",
"description": "An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
},
"duration": {
"type": "string",
"description": "A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
},
"elements": {
"type": "array",
"items": {
"type": "object"
},
"description": "The elements within the journey view"
},
"charts": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of charts to measure within context of the elements of the the journey view"
},
"dateCreated": {
"type": "string",
"description": "The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"elements"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"status": {
"type": "string",
"description": "The status of the job",
"enum": [
"Accepted",
"Executing",
"Complete",
"Failed",
"Cancelled",
"Scheduled"
]
},
"userId": {
"type": "string",
"description": "Id of the user who submitted the request"
}
},
"required": [
"PCID",
"viewId",
"journeyVersionId",
"jobId",
"dateCompleted",
"dateCompletionEstimated",
"dateCreated",
"estimatedCompletionMargin",
"journeyView",
"status",
"userId"
]
}
```
***
## genesys\_journey\_post\_actionmaps
Create an action map.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `action` | object | No | — | The action value |
| `actionMapScheduleGroups` | object | No | — | Action Map Schedule Groups |
| `activation` | object | No | — | The activation value |
| `createdDate` | string | No | — | Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `displayName` | string | Yes | — | Display name of the action map. |
| `endDate` | string | No | — | Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `id` | string | No | — | The globally unique identifier for the object. |
| `ignoreFrequencyCap` | boolean | No | — | Override organization-level frequency cap and always offer web engagements from this action map. |
| `isActive` | boolean | No | — | Whether the action map is active. |
| `modifiedDate` | string | No | — | Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `pageUrlConditions` | object\[] | No | — | URL conditions that a page must match for web actions to be displayable. |
| `selfUri` | string | No | — | The URI for this object |
| `startDate` | string | No | — | Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `triggerWithEventConditions` | object\[] | No | — | List of event conditions that must be satisfied to trigger the action map. |
| `triggerWithOutcomePercentileConditions` | object\[] | No | — | Deprecated. Percentile conditions for outcomes that must be satisfied to trigger the action map. |
| `triggerWithOutcomeProbabilityConditions` | object\[] | No | — | Deprecated. Probability conditions for outcomes that must be satisfied to trigger the action map. |
| `triggerWithOutcomeQuantileConditions` | object\[] | No | — | Deprecated. Quantile conditions for outcomes that must be satisfied to trigger the action map. Journey Outcomes is being removed. See [https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/](https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/) |
| `triggerWithSegments` | string\[] | No | — | Trigger action map if any segment in the list is assigned to a given customer. |
| `version` | integer | No | — | The version of the action map. |
| `weight` | integer | No | — | Weight of the action map with higher number denoting higher weight. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"action": {
"type": "object",
"description": "The action value",
"properties": {
"actionTemplate": {
"type": "object",
"description": "Action Template"
},
"mediaType": {
"type": "string",
"description": "Media type of action.",
"enum": [
"webchat",
"webMessagingOffer",
"contentOffer",
"integrationAction",
"architectFlow",
"openAction"
]
},
"actionTargetId": {
"type": "string",
"description": "Deprecated. Action target ID."
},
"isPacingEnabled": {
"type": "boolean",
"description": "Deprecated. Whether this action should be throttled."
},
"props": {
"type": "object",
"description": "The props value"
},
"architectFlowFields": {
"type": "object",
"description": "Architect Flow Fields"
},
"webMessagingOfferFields": {
"type": "object",
"description": "Web Messaging Offer Fields"
},
"openActionFields": {
"type": "object",
"description": "Open Action Fields"
}
}
},
"actionMapScheduleGroups": {
"type": "object",
"description": "Action Map Schedule Groups",
"properties": {
"actionMapScheduleGroup": {
"type": "object",
"description": "Action Map Schedule Group"
},
"emergencyActionMapScheduleGroup": {
"type": "object",
"description": "Emergency Action Map Schedule Group"
}
},
"required": [
"actionMapScheduleGroup"
]
},
"activation": {
"type": "object",
"description": "The activation value",
"properties": {
"type": {
"type": "string",
"description": "Type of activation."
},
"delayInSeconds": {
"type": "integer",
"description": "Activation delay time amount."
}
},
"required": [
"type"
]
},
"createdDate": {
"type": "string",
"description": "Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"displayName": {
"type": "string",
"description": "Display name of the action map."
},
"endDate": {
"type": "string",
"description": "Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"ignoreFrequencyCap": {
"type": "boolean",
"description": "Override organization-level frequency cap and always offer web engagements from this action map."
},
"isActive": {
"type": "boolean",
"description": "Whether the action map is active."
},
"modifiedDate": {
"type": "string",
"description": "Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"pageUrlConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The URL condition value."
},
"operator": {
"type": "string",
"enum": [
"containsAll",
"containsAny",
"notContainsAll",
"notContainsAny",
"equal",
"notEqual",
"greaterThan",
"greaterThanOrEqual",
"lessThan",
"lessThanOrEqual",
"startsWith",
"endsWith"
],
"description": "The comparison operator."
}
},
"required": [
"operator",
"values"
]
},
"description": "URL conditions that a page must match for web actions to be displayable."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"startDate": {
"type": "string",
"description": "Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"triggerWithEventConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The event key."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The event values."
},
"operator": {
"type": "string",
"enum": [
"containsAll",
"containsAny",
"notContainsAll",
"notContainsAny",
"equal",
"notEqual",
"greaterThan",
"greaterThanOrEqual",
"lessThan",
"lessThanOrEqual",
"startsWith",
"endsWith"
],
"description": "The comparison operator."
},
"streamType": {
"type": "string",
"enum": [
"Web",
"Custom",
"Conversation",
"App"
],
"description": "The stream type for which this condition can be satisfied."
},
"sessionType": {
"type": "string",
"description": "The session type for which this condition can be satisfied."
},
"eventName": {
"type": "string",
"description": "The name of the event for which this condition can be satisfied."
}
},
"required": [
"key",
"sessionType",
"streamType",
"values"
]
},
"description": "List of event conditions that must be satisfied to trigger the action map."
},
"triggerWithOutcomePercentileConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"outcomeId": {
"type": "string",
"description": "The outcome ID."
},
"maximumPercentile": {
"type": "number",
"format": "float",
"description": "Percentile value for the selected outcome, at or above which the action map will trigger."
},
"fallbackPercentile": {
"type": "number",
"format": "float",
"description": "Additional percentile condition, where if set, the action map will trigger if the current outcome percentile is lower or equal to the value."
}
},
"required": [
"maximumPercentile",
"outcomeId"
]
},
"description": "Deprecated. Percentile conditions for outcomes that must be satisfied to trigger the action map."
},
"triggerWithOutcomeProbabilityConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"outcomeId": {
"type": "string",
"description": "The outcome ID."
},
"maximumProbability": {
"type": "number",
"format": "float",
"description": "Probability value for the selected outcome at or above which the action map will trigger."
},
"probability": {
"type": "number",
"format": "float",
"description": "Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."
}
},
"required": [
"maximumProbability",
"outcomeId"
]
},
"description": "Deprecated. Probability conditions for outcomes that must be satisfied to trigger the action map."
},
"triggerWithOutcomeQuantileConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"outcomeId": {
"type": "string",
"description": "The outcome ID."
},
"maxQuantileThreshold": {
"type": "number",
"format": "float",
"description": "This Outcome Quantile Condition is met when sessionMaxQuantile of the OutcomeScore is above this value, (unless fallbackQuantile is set). Range 0.00-1.00"
},
"fallbackQuantileThreshold": {
"type": "number",
"format": "float",
"description": "(Optional) If set, this Condition is met when maxQuantileThreshold is met, AND the current quantile of the OutcomeScore is below this fallbackQuantileThreshold. Range 0.00-1.00"
}
},
"required": [
"maxQuantileThreshold",
"outcomeId"
]
},
"description": "Deprecated. Quantile conditions for outcomes that must be satisfied to trigger the action map. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/"
},
"triggerWithSegments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trigger action map if any segment in the list is assigned to a given customer."
},
"version": {
"type": "integer",
"description": "The version of the action map."
},
"weight": {
"type": "integer",
"description": "Weight of the action map with higher number denoting higher weight."
}
},
"required": [
"PCID",
"displayName"
]
}
```
***
## genesys\_journey\_post\_actionmaps\_estimates\_jobs
Query for estimates
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | -------------------- |
| `outcomeCriteria` | object | No | — | Outcome Criteria |
| `segmentIds` | string\[] | No | — | List of Segment IDs. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"outcomeCriteria": {
"type": "object",
"description": "Outcome Criteria",
"properties": {
"outcomeId": {
"type": "string",
"description": "ID of outcome."
},
"maxProbability": {
"type": "number",
"description": "Probability value for the selected outcome at or above which the action map will trigger."
},
"probability": {
"type": "number",
"description": "Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."
},
"quantile": {
"type": "number",
"description": "Represents the quantity of sessions that have a maximum probability less than the predicted probability."
},
"maxQuantile": {
"type": "number",
"description": "Represents the quantity of sessions that have a maximum probability less than the predicted session max probability."
}
},
"required": [
"outcomeId"
]
},
"segmentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of Segment IDs."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_post\_actiontemplates
Create a single action template.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `contentOffer` | object | No | — | Content Offer |
| `createdDate` | string | No | — | Date when action template was created in ISO-8601 format. |
| `description` | string | No | — | Description of the action template's functionality. |
| `id` | string | No | — | The globally unique identifier for the object. |
| `mediaType` | string | Yes | — | Media type of action described by the action template. |
| `modifiedDate` | string | No | — | Date when action template was last modified in ISO-8601 format. |
| `name` | string | Yes | — | Name of the action template. |
| `selfUri` | string | No | — | The URI for this object |
| `state` | string | Yes | — | Whether the action template is currently active, inactive or deleted. |
| `version` | integer | No | — | The version of the action template. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contentOffer": {
"type": "object",
"description": "Content Offer",
"properties": {
"imageUrl": {
"type": "string",
"description": "URL for image displayed to the customer when displaying content offer."
},
"displayMode": {
"type": "string",
"description": "The display mode of Genesys Widgets when displaying content offer.",
"enum": [
"Modal",
"Overlay",
"Toast"
]
},
"layoutMode": {
"type": "string",
"description": "The layout mode of the text shown to the user when displaying content offer.",
"enum": [
"TextOnly",
"ImageOnly",
"LeftText",
"RightText",
"TopText",
"BottomText"
]
},
"title": {
"type": "string",
"description": "Title used in the header of the content offer."
},
"headline": {
"type": "string",
"description": "Headline displayed above the body text of the content offer."
},
"body": {
"type": "string",
"description": "Body text of the content offer."
},
"callToAction": {
"type": "object",
"description": "Call To Action"
},
"style": {
"type": "object",
"description": "The style value"
},
"imageAltText": {
"type": "string",
"description": "Image description text for accessibility compliance and assistive technology support."
}
},
"required": [
"displayMode",
"layoutMode"
]
},
"createdDate": {
"type": "string",
"description": "Date when action template was created in ISO-8601 format."
},
"description": {
"type": "string",
"description": "Description of the action template's functionality."
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"mediaType": {
"type": "string",
"description": "Media type of action described by the action template.",
"enum": [
"webchat",
"webMessagingOffer",
"contentOffer",
"integrationAction",
"architectFlow",
"openAction"
]
},
"modifiedDate": {
"type": "string",
"description": "Date when action template was last modified in ISO-8601 format."
},
"name": {
"type": "string",
"description": "Name of the action template."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"state": {
"type": "string",
"description": "Whether the action template is currently active, inactive or deleted.",
"enum": [
"Active",
"Inactive",
"Deleted"
]
},
"version": {
"type": "integer",
"description": "The version of the action template."
}
},
"required": [
"PCID",
"mediaType",
"name",
"state"
]
}
```
***
## genesys\_journey\_post\_deployment\_actionevent
Sends an action event, which is used for changing the state of actions that have been offered to the user.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------- |
| `deploymentId` | string | Yes | — | The ID of the deployment sending the beacon. |
| `actionId` | string | Yes | — | UUID for the action, as returned by the Ping endpoint when the action was qualified. |
| `actionState` | string | Yes | — | State the action is transitioning to. |
| `errorCode` | string | No | — | Client defined error code (when state transitions to errored) |
| `errorMessage` | string | No | — | Message of the error returned when the action fails (when state transitions to errored) |
| `id` | string | No | — | The globally unique identifier for the object. |
| `selfUri` | string | No | — | The URI for this object |
| `sessionId` | string | Yes | — | UUID of the customer session for this action. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "The ID of the deployment sending the beacon."
},
"actionId": {
"type": "string",
"description": "UUID for the action, as returned by the Ping endpoint when the action was qualified."
},
"actionState": {
"type": "string",
"description": "State the action is transitioning to.",
"enum": [
"accepted",
"rejected",
"timedout",
"errored",
"ignored",
"qualified",
"offered",
"started",
"engaged",
"qualifiedOutsideSchedule",
"offeredOutsideSchedule",
"abandoned",
"completed",
"frequencyCapReached"
]
},
"errorCode": {
"type": "string",
"description": "Client defined error code (when state transitions to errored)"
},
"errorMessage": {
"type": "string",
"description": "Message of the error returned when the action fails (when state transitions to errored)"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"sessionId": {
"type": "string",
"description": "UUID of the customer session for this action."
}
},
"required": [
"PCID",
"deploymentId",
"actionId",
"actionState",
"sessionId"
]
}
```
***
## genesys\_journey\_post\_deployment\_appevents
Send a journey app event, used for tracking customer activity on an application.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `deploymentId` | string | Yes | — | The ID of the deployment sending the app event. |
| `app` | object | Yes | — | The app value |
| `attributes` | object | No | — | User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items\_in\_cart or subscription\_level. |
| `createdDate` | string | Yes | — | UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `customerCookieId` | string | Yes | — | A UUID representing the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution. |
| `device` | object | Yes | — | The device value |
| `eventName` | string | Yes | — | Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. screen\_viewed, search\_performed, user\_registered. |
| `externalId` | string | No | — | An external identifier for the customer. |
| `networkConnectivity` | object | No | — | Network Connectivity |
| `referrerUrl` | string | No | — | The referrer URL of the first event in the app session. |
| `screenName` | string | Yes | — | The name of the screen, view, or fragment in the app where the event took place. |
| `sdkLibrary` | object | No | — | Sdk Library |
| `searchQuery` | string | No | — | Represents the keywords in a customer search query. |
| `traits` | object | No | — | Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, givenName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "The ID of the deployment sending the app event."
},
"app": {
"type": "object",
"description": "The app value",
"properties": {
"name": {
"type": "string",
"description": "Name of the application (e.g. mybankingapp)."
},
"namespace": {
"type": "string",
"description": "Namespace of the application (e.g. com.genesys.bancodinero)."
},
"version": {
"type": "string",
"description": "Version of the application (e.g. 5.9.27)."
},
"buildNumber": {
"type": "string",
"description": "Build number of the application (e.g. 701)."
}
},
"required": [
"buildNumber",
"name",
"namespace",
"version"
]
},
"attributes": {
"type": "object",
"description": "User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level."
},
"createdDate": {
"type": "string",
"description": "UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"customerCookieId": {
"type": "string",
"description": "A UUID representing the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution."
},
"device": {
"type": "object",
"description": "The device value",
"properties": {
"category": {
"type": "string",
"description": "Device category.",
"enum": [
"desktop",
"mobile",
"tablet",
"other"
]
},
"type": {
"type": "string",
"description": "Device type (e.g. iPad, iPhone, Other)."
},
"isMobile": {
"type": "boolean",
"description": "Flag that is true for mobile devices."
},
"screenHeight": {
"type": "integer",
"description": "Device's screen height."
},
"screenWidth": {
"type": "integer",
"description": "Device's screen width."
},
"screenDensity": {
"type": "integer",
"description": "Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels."
},
"fingerprint": {
"type": "string",
"description": "Fingerprint generated by looking at the individual device features."
},
"osFamily": {
"type": "string",
"description": "Operating system family."
},
"osVersion": {
"type": "string",
"description": "Operating system version."
},
"manufacturer": {
"type": "string",
"description": "Manufacturer of the device."
}
},
"required": [
"category",
"osFamily",
"osVersion",
"type"
]
},
"eventName": {
"type": "string",
"description": "Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. screen_viewed, search_performed, user_registered."
},
"externalId": {
"type": "string",
"description": "An external identifier for the customer."
},
"networkConnectivity": {
"type": "object",
"description": "Network Connectivity",
"properties": {
"carrier": {
"type": "string",
"description": "The name of the network carrier."
},
"bluetoothEnabled": {
"type": "boolean",
"description": "Whether Bluetooth is enabled."
},
"cellularEnabled": {
"type": "boolean",
"description": "Whether Cellular is enabled."
},
"wifiEnabled": {
"type": "boolean",
"description": "Whether Wi-Fi is enabled."
}
},
"required": [
"bluetoothEnabled",
"cellularEnabled",
"wifiEnabled"
]
},
"referrerUrl": {
"type": "string",
"description": "The referrer URL of the first event in the app session."
},
"screenName": {
"type": "string",
"description": "The name of the screen, view, or fragment in the app where the event took place."
},
"sdkLibrary": {
"type": "object",
"description": "Sdk Library",
"properties": {
"name": {
"type": "string",
"description": "The name of the SDK."
},
"version": {
"type": "string",
"description": "The version of the SDK."
}
},
"required": [
"name",
"version"
]
},
"searchQuery": {
"type": "string",
"description": "Represents the keywords in a customer search query."
},
"traits": {
"type": "object",
"description": "Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, givenName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions."
}
},
"required": [
"PCID",
"deploymentId",
"app",
"createdDate",
"customerCookieId",
"device",
"eventName",
"screenName"
]
}
```
***
## genesys\_journey\_post\_deployment\_webevents
Send a journey web event, used for tracking customer activity on a website.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `deploymentId` | string | Yes | — | The ID of the deployment sending the web event. |
| `attributes` | object | No | — | User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items\_in\_cart or subscription\_level. |
| `browser` | object | No | — | The browser value |
| `createdDate` | string | Yes | — | UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `customerCookieId` | string | Yes | — | A UUID representing the customer making the request. |
| `device` | object | No | — | The device value |
| `eventName` | string | Yes | — | Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. page\_viewed, order\_completed, user\_registered. |
| `externalId` | string | No | — | An external identifier for the customer. |
| `ipAddress` | string | No | — | Customer's IP address. |
| `page` | object | Yes | — | Page number for pagination |
| `referrerUrl` | string | No | — | Identifies the referrer URL that originally generated the request for the current page being viewed. |
| `searchQuery` | string | No | — | Represents the keywords in a customer search query. |
| `traits` | object | No | — | Traits are attributes intrinsic to the customer that may be sent in selected events, e.g. email, givenName, cellPhone. Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions. |
| `userAgentString` | string | No | — | Override for HTTP User-Agent string from request header (see [https://tools.ietf.org/html/rfc1945#section-10.15](https://tools.ietf.org/html/rfc1945#section-10.15)). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "The ID of the deployment sending the web event."
},
"attributes": {
"type": "object",
"description": "User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level."
},
"browser": {
"type": "object",
"description": "The browser value",
"properties": {
"family": {
"type": "string",
"description": "Browser family (e.g. Chrome, Safari, Firefox)."
},
"version": {
"type": "string",
"description": "Browser version (e.g. 68.0.3440.84)."
},
"lang": {
"type": "string",
"description": "Language the browser is set to. Must conform to BCP 47."
}
},
"required": [
"family",
"version"
]
},
"createdDate": {
"type": "string",
"description": "UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"customerCookieId": {
"type": "string",
"description": "A UUID representing the customer making the request."
},
"device": {
"type": "object",
"description": "The device value",
"properties": {
"category": {
"type": "string",
"description": "Device category.",
"enum": [
"desktop",
"mobile",
"tablet",
"other"
]
},
"type": {
"type": "string",
"description": "Device type (e.g. iPad, iPhone, Other)."
},
"isMobile": {
"type": "boolean",
"description": "Flag that is true for mobile devices."
},
"screenHeight": {
"type": "integer",
"description": "Device's screen height."
},
"screenWidth": {
"type": "integer",
"description": "Device's screen width."
},
"screenDensity": {
"type": "integer",
"description": "Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels."
},
"osFamily": {
"type": "string",
"description": "Operating system family."
},
"osVersion": {
"type": "string",
"description": "Operating system version."
},
"manufacturer": {
"type": "string",
"description": "Manufacturer of the device."
}
},
"required": [
"category",
"osFamily",
"osVersion",
"type"
]
},
"eventName": {
"type": "string",
"description": "Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. page_viewed, order_completed, user_registered."
},
"externalId": {
"type": "string",
"description": "An external identifier for the customer."
},
"ipAddress": {
"type": "string",
"description": "Customer's IP address."
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"url": {
"type": "string",
"description": "The page URL."
},
"title": {
"type": "string",
"description": "Title of the page."
},
"keywords": {
"type": "string",
"description": "Keywords from the HTML tag of the page."
},
"lang": {
"type": "string",
"description": "ISO 639-1 language code for the page as defined in the tag."
}
},
"required": [
"title",
"url"
]
},
"referrerUrl": {
"type": "string",
"description": "Identifies the referrer URL that originally generated the request for the current page being viewed."
},
"searchQuery": {
"type": "string",
"description": "Represents the keywords in a customer search query."
},
"traits": {
"type": "object",
"description": "Traits are attributes intrinsic to the customer that may be sent in selected events, e.g. email, givenName, cellPhone. Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions."
},
"userAgentString": {
"type": "string",
"description": "Override for HTTP User-Agent string from request header (see https://tools.ietf.org/html/rfc1945#section-10.15)."
}
},
"required": [
"PCID",
"deploymentId",
"createdDate",
"customerCookieId",
"eventName",
"page"
]
}
```
***
## genesys\_journey\_post\_flows\_paths\_query
Query for flow paths.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | --------- | -------- | ------- | ------------------------------------------------------- |
| `category` | string | Yes | — | Category (use case) of the paths within a given domain. |
| `flows` | object\[] | Yes | — | List of flows to query the paths result. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category": {
"type": "string",
"description": "Category (use case) of the paths within a given domain.",
"enum": [
"All",
"Abandoned",
"AgentEscalation",
"Complete",
"Disconnect",
"Error",
"RecognitionFailure",
"Transfer"
]
},
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the flow."
}
},
"required": [
"id"
]
},
"description": "List of flows to query the paths result."
}
},
"required": [
"PCID",
"category",
"flows"
]
}
```
***
## genesys\_journey\_post\_outcomes
Create an outcome.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | --------------------------------------- |
| `associatedValueField` | object | No | — | Associated Value Field |
| `context` | object | No | — | The context value |
| `description` | string | No | — | A description of the outcome. |
| `displayName` | string | Yes | — | The display name of the outcome. |
| `isActive` | boolean | No | — | Whether or not the outcome is active. |
| `isPositive` | boolean | No | — | Whether or not the outcome is positive. |
| `journey` | object | No | — | The journey value |
| `version` | integer | No | — | The version of the outcome. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"associatedValueField": {
"type": "object",
"description": "Associated Value Field",
"properties": {
"dataType": {
"type": "string",
"description": "The data type of the value field.",
"enum": [
"Number",
"Integer"
]
},
"name": {
"type": "string",
"description": "The field name for extracting value from event."
}
},
"required": [
"dataType",
"name"
]
},
"context": {
"type": "object",
"description": "The context value",
"properties": {
"patterns": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of one or more patterns to match."
}
}
},
"description": {
"type": "string",
"description": "A description of the outcome."
},
"displayName": {
"type": "string",
"description": "The display name of the outcome."
},
"isActive": {
"type": "boolean",
"description": "Whether or not the outcome is active."
},
"isPositive": {
"type": "boolean",
"description": "Whether or not the outcome is positive."
},
"journey": {
"type": "object",
"description": "The journey value",
"properties": {
"patterns": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of zero or more patterns to match."
}
}
},
"version": {
"type": "integer",
"description": "The version of the outcome."
}
},
"required": [
"PCID",
"displayName"
]
}
```
***
## genesys\_journey\_post\_outcomes\_predictors
Create an outcome predictor.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------- |
| `outcome` | object | Yes | — | The outcome value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"outcome": {
"type": "object",
"description": "The outcome value",
"properties": {
"id": {
"type": "string",
"description": "ID of outcome."
}
},
"required": [
"id"
]
}
},
"required": [
"PCID",
"outcome"
]
}
```
***
## genesys\_journey\_post\_segments
Create a segment.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------- |
| `assignmentExpirationDays` | integer | No | — | Time, in days, from when the segment is assigned until it is automatically unassigned. |
| `color` | string | No | — | The hexadecimal color value of the segment. Defaults if not provided. |
| `context` | object | No | — | The context value |
| `description` | string | No | — | A description of the segment. |
| `displayName` | string | Yes | — | The display name of the segment. |
| `externalSegment` | object | No | — | External Segment |
| `isActive` | boolean | No | — | Whether or not the segment is active. |
| `journey` | object | No | — | The journey value |
| `shouldDisplayToAgent` | boolean | No | — | Whether or not the segment should be displayed to agent/supervisor users. |
| `version` | integer | No | — | The version of the segment. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assignmentExpirationDays": {
"type": "integer",
"description": "Time, in days, from when the segment is assigned until it is automatically unassigned."
},
"color": {
"type": "string",
"description": "The hexadecimal color value of the segment. Defaults if not provided."
},
"context": {
"type": "object",
"description": "The context value",
"properties": {
"patterns": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of one or more patterns to match. Defaults to an empty list if not provided."
}
}
},
"description": {
"type": "string",
"description": "A description of the segment."
},
"displayName": {
"type": "string",
"description": "The display name of the segment."
},
"externalSegment": {
"type": "object",
"description": "External Segment",
"properties": {
"id": {
"type": "string",
"description": "Identifier for the external segment in the system where it originates from."
},
"name": {
"type": "string",
"description": "Name for the external segment in the system where it originates from."
},
"source": {
"type": "string",
"description": "The external system where the segment originates from.",
"enum": [
"AdobeExperiencePlatform",
"Custom"
]
}
},
"required": [
"id",
"name"
]
},
"isActive": {
"type": "boolean",
"description": "Whether or not the segment is active."
},
"journey": {
"type": "object",
"description": "The journey value",
"properties": {
"patterns": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of zero or more patterns to match. Defaults to an empty list if not provided."
}
}
},
"shouldDisplayToAgent": {
"type": "boolean",
"description": "Whether or not the segment should be displayed to agent/supervisor users."
},
"version": {
"type": "integer",
"description": "The version of the segment."
}
},
"required": [
"PCID",
"displayName"
]
}
```
***
## genesys\_journey\_post\_view\_schedules
Add a new Schedule to a JourneyView
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `viewId` | string | Yes | — | Journey View Id |
| `dateModified` | string | Yes | — | Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `frequency` | string | Yes | — | Frequency of execution |
| `id` | string | No | — | The globally unique identifier for the object. |
| `selfUri` | string | No | — | The URI for this object |
| `user` | object | Yes | — | The user value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
},
"dateModified": {
"type": "string",
"description": "Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"frequency": {
"type": "string",
"description": "Frequency of execution",
"enum": [
"Daily",
"Weekly",
"Monthly"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
}
},
"required": [
"PCID",
"viewId",
"dateModified",
"frequency",
"user"
]
}
```
***
## genesys\_journey\_post\_view\_version\_jobs
Submit a job request for a journey view version.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | -------------------- |
| `viewId` | string | Yes | — | Journey View Id |
| `journeyVersionId` | string | Yes | — | Journey View Version |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
},
"journeyVersionId": {
"type": "string",
"description": "Journey View Version"
}
},
"required": [
"PCID",
"viewId",
"journeyVersionId"
]
}
```
***
## genesys\_journey\_post\_view\_versions
Update a Journey View by ID
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `viewId` | string | Yes | — | View Id |
| `charts` | object\[] | No | — | A list of charts to measure within context of the elements of the the journey view |
| `createdBy` | object | No | — | Created By |
| `dateCreated` | string | No | — | The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateModified` | string | No | — | The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | A description of the journey view |
| `duration` | string | No | — | A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H |
| `elements` | object\[] | Yes | — | The elements within the journey view |
| `id` | string | No | — | The globally unique identifier for the object. |
| `interval` | string | No | — | An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
| `modifiedBy` | object | No | — | Modified By |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `version` | integer | No | — | The version of the journey view |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "View Id"
},
"charts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of the journey view chart"
},
"groupByTime": {
"type": "string",
"enum": [
"Day",
"Week",
"Month",
"Year"
],
"description": "A time unit to group the metrics by. There is a limit on the number of groupBy properties which can be specified."
},
"groupByAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"elementId": {
"type": "string",
"description": "The element in the list of elements which is being grouped by"
},
"attribute": {
"type": "string",
"description": "The attribute of the element being grouped by"
}
}
},
"description": "A list of attributes to group the metrics by. There is a limit on the number of groupBy properties which can be specified."
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the metric within the chart"
},
"elementId": {
"type": "string",
"description": "The element in the list of elements which the metric is measuring"
},
"aggregate": {
"type": "string",
"description": "How to aggregate the given element, defaults to CustomerCount"
},
"displayLabel": {
"type": "string",
"description": "A display label for the metric"
}
}
},
"description": "A list of metrics to calculate within the chart by (aka the y axis)"
},
"displayAttributes": {
"type": "object",
"description": "Display attributes for the chart, such as type, labels and legends"
},
"groupByMax": {
"type": "integer",
"format": "int64",
"description": "A maximum on the number of values being grouped by"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"metrics"
]
},
"description": "A list of charts to measure within context of the elements of the the journey view"
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"emailAddress": {
"type": "string",
"description": "Email address of the user"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "A description of the journey view"
},
"duration": {
"type": "string",
"description": "A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the element within the elements list"
},
"name": {
"type": "string",
"description": "The unique name of the element within the view"
},
"attributes": {
"type": "object",
"description": "Attributes on an element in a journey view"
},
"displayAttributes": {
"type": "object",
"description": "Display attributes for an element in a journey view"
},
"filter": {
"type": "object",
"description": "A set of filters on an element within a journey view"
},
"followedBy": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the element downstream"
},
"constraintWithin": {
"type": "object"
},
"constraintAfter": {
"type": "object"
},
"eventCountType": {
"type": "string",
"description": "The type of events that will be counted. Note: Concurrent will override any JourneyViewLinkTimeConstraint. Default is Sequential."
},
"joinAttributes": {
"type": "array",
"description": "Other (secondary) attributes on which this link should join the customers being counted"
}
}
},
"description": "A list of JourneyViewLink objects, listing the elements downstream of this element"
}
},
"required": [
"attributes",
"id",
"name"
]
},
"description": "The elements within the journey view"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"interval": {
"type": "string",
"description": "An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"emailAddress": {
"type": "string",
"description": "Email address of the user"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"version": {
"type": "integer",
"description": "The version of the journey view"
}
},
"required": [
"PCID",
"viewId",
"elements"
]
}
```
***
## genesys\_journey\_post\_views
Create a new Journey View
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `charts` | object\[] | No | — | A list of charts to measure within context of the elements of the the journey view |
| `createdBy` | object | No | — | Created By |
| `dateCreated` | string | No | — | The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateModified` | string | No | — | The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | A description of the journey view |
| `duration` | string | No | — | A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H |
| `elements` | object\[] | Yes | — | The elements within the journey view |
| `id` | string | No | — | The globally unique identifier for the object. |
| `interval` | string | No | — | An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
| `modifiedBy` | object | No | — | Modified By |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `version` | integer | No | — | The version of the journey view |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"charts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of the journey view chart"
},
"groupByTime": {
"type": "string",
"enum": [
"Day",
"Week",
"Month",
"Year"
],
"description": "A time unit to group the metrics by. There is a limit on the number of groupBy properties which can be specified."
},
"groupByAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"elementId": {
"type": "string",
"description": "The element in the list of elements which is being grouped by"
},
"attribute": {
"type": "string",
"description": "The attribute of the element being grouped by"
}
}
},
"description": "A list of attributes to group the metrics by. There is a limit on the number of groupBy properties which can be specified."
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the metric within the chart"
},
"elementId": {
"type": "string",
"description": "The element in the list of elements which the metric is measuring"
},
"aggregate": {
"type": "string",
"description": "How to aggregate the given element, defaults to CustomerCount"
},
"displayLabel": {
"type": "string",
"description": "A display label for the metric"
}
}
},
"description": "A list of metrics to calculate within the chart by (aka the y axis)"
},
"displayAttributes": {
"type": "object",
"description": "Display attributes for the chart, such as type, labels and legends"
},
"groupByMax": {
"type": "integer",
"format": "int64",
"description": "A maximum on the number of values being grouped by"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"metrics"
]
},
"description": "A list of charts to measure within context of the elements of the the journey view"
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"emailAddress": {
"type": "string",
"description": "Email address of the user"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "A description of the journey view"
},
"duration": {
"type": "string",
"description": "A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the element within the elements list"
},
"name": {
"type": "string",
"description": "The unique name of the element within the view"
},
"attributes": {
"type": "object",
"description": "Attributes on an element in a journey view"
},
"displayAttributes": {
"type": "object",
"description": "Display attributes for an element in a journey view"
},
"filter": {
"type": "object",
"description": "A set of filters on an element within a journey view"
},
"followedBy": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the element downstream"
},
"constraintWithin": {
"type": "object"
},
"constraintAfter": {
"type": "object"
},
"eventCountType": {
"type": "string",
"description": "The type of events that will be counted. Note: Concurrent will override any JourneyViewLinkTimeConstraint. Default is Sequential."
},
"joinAttributes": {
"type": "array",
"description": "Other (secondary) attributes on which this link should join the customers being counted"
}
}
},
"description": "A list of JourneyViewLink objects, listing the elements downstream of this element"
}
},
"required": [
"attributes",
"id",
"name"
]
},
"description": "The elements within the journey view"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"interval": {
"type": "string",
"description": "An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"emailAddress": {
"type": "string",
"description": "Email address of the user"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"version": {
"type": "integer",
"description": "The version of the journey view"
}
},
"required": [
"PCID",
"elements"
]
}
```
***
## genesys\_journey\_post\_views\_encodings\_validate
Validate whether an encoding exist for a label/value combination.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------ |
| `body` | object\[] | No | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the label"
},
"value": {
"type": "string",
"description": "Value of the label"
},
"encoded": {
"type": "boolean",
"description": "Whether the label is encoded or not"
}
},
"required": [
"encoded",
"name",
"value"
]
},
"description": "Request body"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_journey\_put\_view\_schedules
Update the Schedule for a JourneyView
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `viewId` | string | Yes | — | Journey View Id |
| `dateModified` | string | Yes | — | Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `frequency` | string | Yes | — | Frequency of execution |
| `id` | string | No | — | The globally unique identifier for the object. |
| `selfUri` | string | No | — | The URI for this object |
| `user` | object | Yes | — | The user value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "Journey View Id"
},
"dateModified": {
"type": "string",
"description": "Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"frequency": {
"type": "string",
"description": "Frequency of execution",
"enum": [
"Daily",
"Weekly",
"Monthly"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
}
},
"required": [
"PCID",
"viewId",
"dateModified",
"frequency",
"user"
]
}
```
***
## genesys\_journey\_put\_view\_version
Update a Journey View by ID and version
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `viewId` | string | Yes | — | View Id |
| `versionId` | string | Yes | — | Version Id |
| `charts` | object\[] | No | — | A list of charts to measure within context of the elements of the the journey view |
| `createdBy` | object | No | — | Created By |
| `dateCreated` | string | No | — | The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateModified` | string | No | — | The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | A description of the journey view |
| `duration` | string | No | — | A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H |
| `elements` | object\[] | Yes | — | The elements within the journey view |
| `id` | string | No | — | The globally unique identifier for the object. |
| `interval` | string | No | — | An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
| `modifiedBy` | object | No | — | Modified By |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `version` | integer | No | — | The version of the journey view |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "string",
"description": "View Id"
},
"versionId": {
"type": "string",
"description": "Version Id"
},
"charts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of the journey view chart"
},
"groupByTime": {
"type": "string",
"enum": [
"Day",
"Week",
"Month",
"Year"
],
"description": "A time unit to group the metrics by. There is a limit on the number of groupBy properties which can be specified."
},
"groupByAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"elementId": {
"type": "string",
"description": "The element in the list of elements which is being grouped by"
},
"attribute": {
"type": "string",
"description": "The attribute of the element being grouped by"
}
}
},
"description": "A list of attributes to group the metrics by. There is a limit on the number of groupBy properties which can be specified."
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the metric within the chart"
},
"elementId": {
"type": "string",
"description": "The element in the list of elements which the metric is measuring"
},
"aggregate": {
"type": "string",
"description": "How to aggregate the given element, defaults to CustomerCount"
},
"displayLabel": {
"type": "string",
"description": "A display label for the metric"
}
}
},
"description": "A list of metrics to calculate within the chart by (aka the y axis)"
},
"displayAttributes": {
"type": "object",
"description": "Display attributes for the chart, such as type, labels and legends"
},
"groupByMax": {
"type": "integer",
"format": "int64",
"description": "A maximum on the number of values being grouped by"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"metrics"
]
},
"description": "A list of charts to measure within context of the elements of the the journey view"
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"emailAddress": {
"type": "string",
"description": "Email address of the user"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "A description of the journey view"
},
"duration": {
"type": "string",
"description": "A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the element within the elements list"
},
"name": {
"type": "string",
"description": "The unique name of the element within the view"
},
"attributes": {
"type": "object",
"description": "Attributes on an element in a journey view"
},
"displayAttributes": {
"type": "object",
"description": "Display attributes for an element in a journey view"
},
"filter": {
"type": "object",
"description": "A set of filters on an element within a journey view"
},
"followedBy": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the element downstream"
},
"constraintWithin": {
"type": "object"
},
"constraintAfter": {
"type": "object"
},
"eventCountType": {
"type": "string",
"description": "The type of events that will be counted. Note: Concurrent will override any JourneyViewLinkTimeConstraint. Default is Sequential."
},
"joinAttributes": {
"type": "array",
"description": "Other (secondary) attributes on which this link should join the customers being counted"
}
}
},
"description": "A list of JourneyViewLink objects, listing the elements downstream of this element"
}
},
"required": [
"attributes",
"id",
"name"
]
},
"description": "The elements within the journey view"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"interval": {
"type": "string",
"description": "An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"emailAddress": {
"type": "string",
"description": "Email address of the user"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"version": {
"type": "integer",
"description": "The version of the journey view"
}
},
"required": [
"PCID",
"viewId",
"versionId",
"elements"
]
}
```