This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

The getEmailClicks operation retrieves the details of all email clicks.

getEmailClicks
<pardot.getEmailClicks>
    <createdAfter>{$ctx:createdAfter}</createdAfter>
    <createdBefore>{$ctx:createdBefore}</createdBefore>
    <idGreaterThan>{$ctx:idGreaterThan}</idGreaterThan>
    <listEmailId>{$ctx:listEmailId}</listEmailId>
    <dripProgramActionId>{$ctx:dripProgramActionId}</dripProgramActionId>
    <emailTemplateId>{$ctx:emailTemplateId}</emailTemplateId>
    <trackerRedirectId>{$ctx:trackerRedirectId}</trackerRedirectId>
    <limit>{$ctx:limit}</limit>
</pardot.getEmailClicks>
Properties
  • createdAfter: Selects campaigns that were created after the specified time.
  • createdBefore: Selects campaigns that were created before the specified time.
  • idGreaterThan: Selects campaigns with IDs greater than the specified integer.
  • listEmailId: Selects only email clicks generated by assets whose list email matches the specified ID.
  • dripProgramActionId:  Selects only email clicks generated by the drip program action with the specified ID.
  • emailTemplateId:  Selects only email clicks generated by the email template with the specified ID.
  • trackerRedirectId:  Selects only email clicks generated by the tracker redirect with the specified ID.
  • limit:  Specifies the number of results to be returned.
Sample request

Following is a sample REST/JSON request that can be handled by the getCampaigns  operation.

Sample Request for getEmailClicks
<request>
   <apiUrl>https://pi.pardot.com/api</apiUrl>
   <email>johndoe@wso2.com</email>
   <password>john4doe</password>
   <userKey>1b3cj2uh4bf9jj3xxx5b85</userKey>
   <apiVersion>3</apiVersion>
   <createdAfter>yesterday</createdAfter>
</request>
Related Pardot documentation

http://developer.pardot.com/kb/api-version-4/batch-email-clicks/

Sample configuration

Following is a sample proxy service that illustrates how to connect to Pardot with the init operation and use the getEmailClicks  operation. The sample request for this proxy can be found in the  getEmailClicks  sample request.

Sample Proxy
<proxy xmlns="http://ws.apache.org/ns/synapse" name="getEmailClicks" transports="https,http" statistics="disable" trace="disable" startOnLoad="true">
   <target>
      <inSequence>
         <property name="apiUrl" expression="//apiUrl" />
         <property name="email" expression="//email" />
         <property name="password" expression="//password" />
         <property name="userKey" expression="//userKey" />
         <property name="apiVersion" expression="//apiVersion" />
         <property name="createdAfter" expression="//createdAfter" />
         <property name="createdAfter" expression="//createdAfter" />
         <property name="createdBefore" expression="//createdBefore" />
         <property name="idGreaterThan" expression="//idGreaterThan" />
         <property name="idLessThan" expression="//idLessThan" />
         <property name="updatedAfter" expression="//updatedAfter" />
         <property name="updatedBefore" expression="//updatedBefore" />
         <property name="name" expression="//name" />
         <property name="limit" expression="//limit" />
         <property name="offset" expression="//offset" />
         <property name="sortBy" expression="//sortBy" />
         <property name="sortOrder" expression="//sortOrder" />
         <pardot.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <email>{$ctx:email}</email>
            <password>{$ctx:password}</password>
            <userKey>{$ctx:userKey}</userKey>
            <apiVersion>{$ctx:apiVersion}</apiVersion>
         </pardot.init>
         <pardot.getEmailClicks>
             <createdAfter>{$ctx:createdAfter}</createdAfter>
             <createdBefore>{$ctx:createdBefore}</createdBefore>
             <idGreaterThan>{$ctx:idGreaterThan}</idGreaterThan>
             <listEmailId>{$ctx:listEmailId}</listEmailId>
             <dripProgramActionId>{$ctx:dripProgramActionId}</dripProgramActionId>
             <emailTemplateId>{$ctx:emailTemplateId}</emailTemplateId>
             <trackerRedirectId>{$ctx:trackerRedirectId}</trackerRedirectId>
             <limit>{$ctx:limit}</limit>
         </pardot.getEmailClicks>
         <respond />
      </inSequence>
      <outSequence>
         <send />
      </outSequence>
   </target>
   <description />
</proxy>
  • No labels