Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The getEmailClicks operation retrieves the details of all email clicks.

Code Block
languagexml
titlegetCampaignsgetEmailClicks
<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.

...

Code Block
languagexml
titleSample Request for getCampaignsgetEmailClicks
<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>

...

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

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

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

Code Block
languagexml
titleSample 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="idLessThanlistEmailId" expression="//idLessThanlistEmailId" />
         <property name="updatedAfterdripProgramActionId" expression="//updatedAfterdripProgramActionId" />
         <property name="updatedBeforeemailTemplateId" expression="//updatedBeforeemailTemplateId" />
         <property name="nametrackerRedirectId" expression="//nametrackerRedirectId" />
         <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>