What can I do with emailLinkClick?

Link clicks give you insight into subscriber interactions:

  • Fetch click events for a particular emailmessagelink_id, task_id or subscriber_id.
  • Try polling regularly and responding to events as they happen.

Use clickAutomation for enhanced, automated functionality.

GET /emailLinkClick or /emailLinkClick/:id

AttributeTypeFilterSortDescription
id
stringYes*YesUnique ID of the link click event.
emailmessagelink_id
intYesNoID of the link in the message.
subscriber_id
intYes*NoID of the subscriber who clicked the link.
task_id
intYes*NoID of the task containing the link.
cdate
decimalNoYesTimestamp at which the click occurred.

*GET requires at least one of: id, subscriber_id, task_id.

HEAD /emailLinkClick or /emailLinkClick/:id

AttributeTypePresenceDescription
id
stringOptional*Unique ID of the link click event.
emailmessagelink_id
intOptionalID of the link in the message.
subscriber_id
intOptional*ID of the subscriber who clicked the link.
task_id
intOptional*ID of the task containing the link.

*HEAD requires at least one of: id, subscriber_id, task_id.

POST /emailLinkClick

This method is not supported.

PUT /emailLinkClick or /emailLinkClick/:id

This method is not supported.

DELETE /emailLinkClick or /emailLinkClick/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":                  123456,
    "emailmessagelink_id": 789,
    "subscriber_id":       123123123,
    "task_id":             12333,
    "cdate":               1379502479,
}