Email Click Object
Account Engagement emails can contain links to download files. Use email click resources to learn more about how your prospects interact with the email links. Learn more about email clicks in Salesforce Help.
Include the authentication header with every request. For information on how to authenticate, see Authentication.
| Resource Name | Operation | Description |
|---|---|---|
| Email Clicks Query | GET | Request information for the email clicks that matches the specified criteria. |
Request information for email clicks that match the specified criteria. You can specify the email clicks and the fields to request. A maximum of 200 are returned.
Use these parameters to specify which email clicks are returned. Parameters can be used in any combination and in any order unless otherwise specified.
Notes:
- Parameters must be URL-encoded.
- Dates and times must use GNU Date Input Syntax (yyyy-mm-dd:hh:ss
). - For a full listing of email clicks fields see Object Field References.
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
created_after | string | today, yesterday, last_7_days, this_month, last_month,<custom_time> | Request email clicks created after the specified time. Example: To request forms created in 2020, use /api/emailClicks/version/4/do/query?created_after=2019-12-31 24:59:59. |
created_before | string | today, yesterday, last_7_days, this_month, last_month, <custom_time> | Request email clicks created before the specified time. Doesn’t include email clicks created at the specified time. Example: To request email clicks created before today (but not created today), use /api/emailClicks/version/4/do/query?created_before=today. |
id_greater_than | integer | Any positive integer | Request email clicks that have an Account Engagement ID greater than the specified number. Example: to request email clicks resulting from emails that were sent by the email list with Account Engagement ID 126xx, and that have an Account Engagement ID greater than 123, use api/emailClick/version/4/do/query?id_greater_than=123&list_email_id=126xx. |
list_email_id | integer | Any positive integer | Selects only email clicks generated by assets whose list email matches the specified Account Engagement ID. Example: to request email clicks from emails that were sent by the email list with Account Engagement ID 1263xx, use /api/emailClick/version/4/do/query?list_email_id=1263xx |
drip_program_action_id | integer | Any positive integer | Deprecated. Selects only email clicks generated by an engagement program action with the specified Account Engagement ID. |
email_template_id | integer | Any positive integer | Selects only email clicks generated by the email template with the specified Account Engagement ID. |
tracker_redirect_id | integer | Any positive integer | Selects only email clicks generated by the tracker redirect with the specified Account Engagement ID. |
| Tag | Description |
|---|---|
<result> | Parent tag. Contains information about the email clicks that match the parameters specified in your query. |
<total_results> | Contains the number of email clicks selected by the query. Note: The query request returns a maximum of 200 email clicks. If your query matches more than 200 email clicks, you can make several requests to retrieve all matching records. |
<emailClick> | The information for a single email click. See Email Clicks in Object Field References. |