Redigera

Dela via


ActionEvent in Customer Insights Journeys

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
ActionStatus Action status CustomerInsightsJourneys/actionevent
ParentActionId Parent action id CustomerInsightsJourneys/actionevent
Reason Reason CustomerInsightsJourneys/actionevent
ReasonDetail Reason Detail CustomerInsightsJourneys/actionevent
ProfileId Unique identifier of the profile. CustomerInsightsJourneys/actionevent
ProfileType The profile type (Contact, Lead or CI Profile) CustomerInsightsJourneys/actionevent
MessageId Message ID CustomerInsightsJourneys/actionevent
IsUnresolvedProfile CustomerInsightsJourneys/actionevent
JourneyRunId Unique identifier of the Journey's execution. CustomerInsightsJourneys/actionevent
JourneyActionId Journey Action Id CustomerInsightsJourneys/actionevent
CustomerJourneyId Unique identifier of the Customer journey CustomerInsightsJourneys/actionevent
BusinessUnitId Unique identifier of the Business unit. CustomerInsightsJourneys/actionevent
IdempotencyId Idempotency ID defines uniqueness of an analytics event. CustomerInsightsJourneys/actionevent
InternalMarketingInteractionId Internal marketing interaction Id. CustomerInsightsJourneys/actionevent
OrganizationId Organization Id. CustomerInsightsJourneys/actionevent
Timestamp Indicates the exact date and time when the interaction was emitted. CustomerInsightsJourneys/actionevent
Version Interaction version. Used for updating the interaction. CustomerInsightsJourneys/actionevent
SourceSystem Refers to the source system that generated the interaction. Outbound marketing (OBM) is represented by value 1. Any other value than 1 represents Real-time journeys (RTJ). CustomerInsightsJourneys/actionevent
InteractionType Type of the interaction. CustomerInsightsJourneys/actionevent

ActionStatus

Action status
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionAction status
dataFormatstring

Traits

List of traits for the ActionStatus attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAction status
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

ParentActionId

Parent action id
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionParent action id
dataFormatstring

Traits

List of traits for the ParentActionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enParent action id
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

Reason

Reason
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionReason
dataFormatstring

Traits

List of traits for the Reason attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReason
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

ReasonDetail

Reason Detail
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionReason Detail
dataFormatstring

Traits

List of traits for the ReasonDetail attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReason Detail
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

ProfileId

Unique identifier of the profile.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionUnique identifier of the profile.
dataFormatstring

Traits

List of traits for the ProfileId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the profile.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

ProfileType

The profile type (Contact, Lead or CI Profile)
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionThe profile type (Contact, Lead or CI Profile)
dataFormatstring

Traits

List of traits for the ProfileType attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe profile type (Contact, Lead or CI Profile)
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

MessageId

Message ID
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionMessage ID
dataFormatguid

Traits

List of traits for the MessageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enMessage ID
entitya reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

IsUnresolvedProfile

First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
dataFormatboolean

Traits

List of traits for the IsUnresolvedProfile attribute are listed below.

is.dataFormat.boolean
is.dataFormat.boolean

JourneyRunId

Unique identifier of the Journey's execution.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionUnique identifier of the Journey's execution.
dataFormatguid

Traits

List of traits for the JourneyRunId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the Journey's execution.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

JourneyActionId

Journey Action Id
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionJourney Action Id
dataFormatstring

Traits

List of traits for the JourneyActionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enJourney Action Id
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

CustomerJourneyId

Unique identifier of the Customer journey
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
description Unique identifier of the Customer journey
dataFormatguid

Traits

List of traits for the CustomerJourneyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
en Unique identifier of the Customer journey
entitya reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

BusinessUnitId

Unique identifier of the Business unit.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionUnique identifier of the Business unit.
dataFormatguid

Traits

List of traits for the BusinessUnitId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/BusinessUnit.cdm.json/BusinessUnitbusinessUnitId
entitya reference to the constant entity holding the list of entity references

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the Business unit.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

IdempotencyId

Idempotency ID defines uniqueness of an analytics event.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionIdempotency ID defines uniqueness of an analytics event.
dataFormatstring

Traits

List of traits for the IdempotencyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIdempotency ID defines uniqueness of an analytics event.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

InternalMarketingInteractionId

Internal marketing interaction Id.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionInternal marketing interaction Id.
dataFormatstring

Traits

List of traits for the InternalMarketingInteractionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInternal marketing interaction Id.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

OrganizationId

Organization Id.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionOrganization Id.
dataFormatguid

Traits

List of traits for the OrganizationId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrganization Id.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

Timestamp

Indicates the exact date and time when the interaction was emitted.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionIndicates the exact date and time when the interaction was emitted.
dataFormatdateTime

Traits

List of traits for the Timestamp attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the exact date and time when the interaction was emitted.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

Version

Interaction version. Used for updating the interaction.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionInteraction version. Used for updating the interaction.
dataFormatint32

Traits

List of traits for the Version attribute are listed below.

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInteraction version. Used for updating the interaction.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

SourceSystem

Refers to the source system that generated the interaction. Outbound marketing (OBM) is represented by value 1. Any other value than 1 represents Real-time journeys (RTJ).
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
description Refers to the source system that generated the interaction. Outbound marketing (OBM) is represented by value 1. Any other value than 1 represents Real-time journeys (RTJ).
dataFormatint32

Traits

List of traits for the SourceSystem attribute are listed below.

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
en Refers to the source system that generated the interaction. Outbound marketing (OBM) is represented by value 1. Any other value than 1 represents Real-time journeys (RTJ).
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

InteractionType

Type of the interaction.
First included in: CustomerInsightsJourneys/actionevent (this entity)

Properties

NameValue
descriptionType of the interaction.
dataFormatstring

Traits

List of traits for the InteractionType attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType of the interaction.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object