Email Click Object

Pardot 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.

Email Click Resources

Resource NameOperationDescription
Email Clicks QueryGETRequest information for the email clicks that matches the specified criteria.

Email Clicks Query

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.

URI

Parameters to Select Email Clicks

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:

ParameterTypePossible ValuesDescription
created_afterstringtoday, 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_beforestringtoday, 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_thanintegerAny positive integerRequest email clicks that have a Pardot ID greater than the specified number. Example: to request email clicks resulting from emails that were sent by the email list with Pardot ID 126xx, and that have a Pardot ID greater than 123, use api/emailClick/version/4/do/query?id_greater_than=123&list_email_id=126xx.
list_email_idintegerAny positive integerSelects only email clicks generated by assets whose list email matches the specified Pardot ID. Example: to request email clicks from emails that were sent by the email list with Pardot ID 1263xx, use /api/emailClick/version/4/do/query?list_email_id=1263xx
drip_program_action_idintegerAny positive integerDeprecated. Selects only email clicks generated by an engagement program action with the specified Pardot ID.
email_template_idintegerAny positive integerSelects only email clicks generated by the email template with the specified Pardot ID.
tracker_redirect_idintegerAny positive integerSelects only email clicks generated by the tracker redirect with the specified Pardot ID.

XML Response

TagDescription
<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.