CustomLinkClicked 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

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic 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.

Parameter	Value	Data type	Explanation
level	"resolved"	string	Possible values: logical, composition, resolved

Attributes

Name	Description	First Included in Instance
Sender	Sender of the custom message	CustomerInsightsJourneys/customlinkclicked
Recipient	Receipient of the custom message	CustomerInsightsJourneys/customlinkclicked
ChannelType	Type of the channel (custom, sms, push, email)	CustomerInsightsJourneys/customlinkclicked
ChannelDefinitionId	Identifier of the specific custom channel	CustomerInsightsJourneys/customlinkclicked
TargetUrl	Represents the actual URL that a user clicked, including any personalized elements. It shows the specific webpage or destination the user was directed to after clicking.	CustomerInsightsJourneys/customlinkclicked
LinkName	Link name	CustomerInsightsJourneys/customlinkclicked
OriginalContentLink	Original content link	CustomerInsightsJourneys/customlinkclicked
ProfileId	Unique identifier of the profile.	CustomerInsightsJourneys/customlinkclicked
ProfileType	The profile type (Contact, Lead or CI Profile)	CustomerInsightsJourneys/customlinkclicked
MessageId	Message ID	CustomerInsightsJourneys/customlinkclicked
IsUnresolvedProfile		CustomerInsightsJourneys/customlinkclicked
JourneyRunId	Unique identifier of the Journey's execution.	CustomerInsightsJourneys/customlinkclicked
JourneyActionId	Journey Action Id	CustomerInsightsJourneys/customlinkclicked
CustomerJourneyId	Unique identifier of the Customer journey	CustomerInsightsJourneys/customlinkclicked
BusinessUnitId	Unique identifier of the Business unit.	CustomerInsightsJourneys/customlinkclicked
IdempotencyId	Idempotency ID defines uniqueness of an analytics event.	CustomerInsightsJourneys/customlinkclicked
InternalMarketingInteractionId	Internal marketing interaction Id.	CustomerInsightsJourneys/customlinkclicked
OrganizationId	Organization Id.	CustomerInsightsJourneys/customlinkclicked
Timestamp	Indicates the exact date and time when the interaction was emitted.	CustomerInsightsJourneys/customlinkclicked
Version	Interaction version. Used for updating the interaction.	CustomerInsightsJourneys/customlinkclicked
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/customlinkclicked
InteractionType	Type of the interaction.	CustomerInsightsJourneys/customlinkclicked

Sender

Sender of the custom message
First included in: CustomerInsightsJourneys/customlinkclicked (this entity)

Properties

Name	Value
description	Sender of the custom message
dataFormat	string

Traits

List of traits for the Sender 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Sender of the custom message	entity	a 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

Recipient

Receipient of the custom message
First included in: CustomerInsightsJourneys/customlinkclicked (this entity)

Properties

Name	Value
description	Receipient of the custom message
dataFormat	string

Traits

List of traits for the Recipient 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Receipient of the custom message	entity	a 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

ChannelType

Type of the channel (custom, sms, push, email)
First included in: CustomerInsightsJourneys/customlinkclicked (this entity)

Properties

Name	Value
description	Type of the channel (custom, sms, push, email)
dataFormat	string

Traits

List of traits for the ChannelType 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type of the channel (custom, sms, push, email)	entity	a 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

ChannelDefinitionId

Identifier of the specific custom channel
First included in: CustomerInsightsJourneys/customlinkclicked (this entity)

Properties

Name	Value
description	Identifier of the specific custom channel
dataFormat	guid

Traits

List of traits for the ChannelDefinitionId 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Identifier of the specific custom channel	entity	a 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

TargetUrl

Represents the actual URL that a user clicked, including any personalized elements. It shows the specific webpage or destination the user was directed to after clicking.
First included in: CustomerInsightsJourneys/customlinkclicked (this entity)

Properties

Name	Value
description	Represents the actual URL that a user clicked, including any personalized elements. It shows the specific webpage or destination the user was directed to after clicking.
dataFormat	string

Traits

List of traits for the TargetUrl 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Represents the actual URL that a user clicked, including any personalized elements. It shows the specific webpage or destination the user was directed to after clicking.	entity	a 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

LinkName

Link name
First included in: CustomerInsightsJourneys/customlinkclicked (this entity)

Properties

Name	Value
description	Link name
dataFormat	string

Traits

List of traits for the LinkName 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Link name	entity	a 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

OriginalContentLink

Original content link
First included in: CustomerInsightsJourneys/customlinkclicked (this entity)

Properties

Name	Value
description	Original content link
dataFormat	string

Traits

List of traits for the OriginalContentLink 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Original content link	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Unique identifier of the profile.
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the profile.	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	The profile type (Contact, Lead or CI Profile)
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The profile type (Contact, Lead or CI Profile)	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Message ID
dataFormat	guid

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Message ID	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
dataFormat	boolean

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/customlinkclicked (this entity)

Properties

Name	Value
description	Unique identifier of the Journey's execution.
dataFormat	guid

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the Journey's execution.	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Journey Action Id
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Journey Action Id	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Unique identifier of the Customer journey
dataFormat	guid

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the Customer journey	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Unique identifier of the Business unit.
dataFormat	guid

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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/BusinessUnit.cdm.json/BusinessUnit businessUnitId	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the Business unit.	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Idempotency ID defines uniqueness of an analytics event.
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Idempotency ID defines uniqueness of an analytics event.	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Internal marketing interaction Id.
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Internal marketing interaction Id.	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Organization Id.
dataFormat	guid

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Organization Id.	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Indicates the exact date and time when the interaction was emitted.
dataFormat	dateTime

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Indicates the exact date and time when the interaction was emitted.	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
description	Interaction version. Used for updating the interaction.
dataFormat	int32

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Interaction version. Used for updating the interaction.	entity	a 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/customlinkclicked (this entity)

Properties

Name	Value
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).
dataFormat	int32

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText 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).	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

InteractionType

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

Properties

Name	Value
description	Type of the interaction.
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type of the interaction.	entity	a 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