ClickEvent

Contains information about a click event. A click event occurs when a subscriber clicks a link in a message.

This object includes the properties listed in this table.

NameData TypeDescription
BatchIDIntTies triggered send sent events to other events, such as clicks and opens that occur at a later date and time.
ClientClientID objectSpecifies the account ownership and context of an object.
CorrelationIDStringIdentifies correlation of objects across several requests.
CreatedDateDateTimeThe date and time when the object was created.
CustomerKeyStringUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
EventDateDateTimeDate when a tracking event occurred.
EventTypeEventType objectThe type of tracking event.
IDIntRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
ModifiedDateDateTimeThe date and time when the object was last modified.
ObjectIDStringSystem-controlled, read-only text string identifier for object.
ObjectStateStringNot used.
OwnerOwner objectDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyStringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
SendIDIntContains identifier for a specific send.
SubscriberKeyStringIdentification of a specific subscriber.
TriggeredSendDefinitionObjectIDStringIdentifies the triggered send definition associated with an event. This value also appears in tracking events to allow you to tie those events to a specific triggered send.
URLStringIndicates URL included in an event or configuration.
URLIDIntIndicates URL ID associated with a click tracking event.