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 3 Current »

The getVisitorActivities operation retrieves the details of all visitor activities .

getVisitorActivities
<pardot.getVisitorActivities>
    <createdAfter>{$ctx:createdAfter}</createdAfter>
    <createdBefore>{$ctx:createdBefore}</createdBefore>
    <idGreaterThan>{$ctx:idGreaterThan}</idGreaterThan>
    <idLessThan>{$ctx:idLessThan}</idLessThan>
    <prospectOnly>{$ctx:prospectOnly}</prospectOnly>
    <type>{$ctx:type}</type>
    <campaignId>{$ctx:campaignId}</campaignId>
    <customUrlId>{$ctx:customUrlId}</customUrlId>
    <emailId>{$ctx:emailId}</emailId>
    <fileId>{$ctx:fileId}</fileId>
    <formId>{$ctx:formId}</formId>
    <formHandlerId>{$ctx:formHandlerId}</formHandlerId>
    <landingPageId>{$ctx:landingPageId}</landingPageId>
    <prospectId>{$ctx:prospectId}</prospectId>
    <visitorId>{$ctx:visitorId}</visitorId>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <sortBy>{$ctx:sortBy}</sortBy>
    <sortOrder>{$ctx:sortOrder}</sortOrder>
    <output>{$ctx:output}</output>
</pardot.getVisitorActivities>
Properties
  • createdAfter: Selects visitor activities that were created after the specified time.
  • createdBefore: Selects visitor activities that were created before the specified time.
  • idGreaterThan: Selects visitor activities with IDs greater than the specified integer.
  • idLessThan: Selects visitor activities with IDs less than the specified integer.
  • prospectOnly: Selects prospects based on whether they are assigned.
  • type: Selects prospects based on whether they are assigned to a specified user.
  • campaignId: Selects only visitor activities generated by assets whose campaign matches the specified ID.
  • customUrlId: Selects only visitor activities generated by the custom redirect with the specified ID.
  • emailId: Selects only visitor activities generated by the email with the specified ID.
  • fileId: Selects only visitor activities generated by the file with the specified ID.
  • formId: Selects only visitor activities generated by the form with the specified ID.
  • formHandlerId: Selects only visitor activities generated by the form handler with the specified ID.
  • landingPageId: Selects only visitor activities generated by the landing page with the specified ID.
  • prospectId: Selects only visitor activities associated with the prospect with the specified ID.
  • visitorId: Selects only visitor activities associated with the visitor with the specified ID.
  • limit:  Specifies the number of results to be returned.
  • offset:  Specifies the first matching visitor to be returned in the query response.
  • sortBy: Specifies the field that should be used to sort the results of the query.
  • sortOrder: Specifies the ordering to be used when sorting the results of the query.
  • output: Specifies the format to be used when returning the results of the query.
Sample request

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

Sample Request for getVisitorActivities
<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/visitor activities/

Sample configuration

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

Sample Proxy
<proxy xmlns="http://ws.apache.org/ns/synapse" name="getVisitorActivities" 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="createdBefore" expression="//createdBefore" />
         <property name="idGreaterThan" expression="//idGreaterThan" />
         <property name="idLessThan" expression="//idLessThan" />
         <property name="prospectOnly" expression="//prospectOnly" />
         <property name="type" expression="//type" />
         <property name="campaignId" expression="//campaignId" />
         <property name="customUrlId" expression="//customUrlId" />
         <property name="emailId" expression="//emailId" />
         <property name="fileId" expression="//fileId" />
         <property name="formId" expression="//formId" />
         <property name="formHandlerId" expression="//formHandlerId" />
         <property name="landingPageId" expression="//landingPageId" />
         <property name="prospectId" expression="//prospectId" />
         <property name="visitorId" expression="//visitorId" />
         <property name="limit" expression="//limit" />
         <property name="offset" expression="//offset" />
         <property name="sortBy" expression="//sortBy" />
         <property name="sortOrder" expression="//sortOrder" />
         <property name="output" expression="//output" />
         <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.getVisitorActivities>
             <createdAfter>{$ctx:createdAfter}</createdAfter>
             <createdBefore>{$ctx:createdBefore}</createdBefore>
             <idGreaterThan>{$ctx:idGreaterThan}</idGreaterThan>
             <idLessThan>{$ctx:idLessThan}</idLessThan>
             <prospectOnly>{$ctx:prospectOnly}</prospectOnly>
             <type>{$ctx:type}</type>
             <campaignId>{$ctx:campaignId}</campaignId>
             <customUrlId>{$ctx:customUrlId}</customUrlId>
             <emailId>{$ctx:emailId}</emailId>
             <fileId>{$ctx:fileId}</fileId>
             <formId>{$ctx:formId}</formId>
             <formHandlerId>{$ctx:formHandlerId}</formHandlerId>
             <landingPageId>{$ctx:landingPageId}</landingPageId>
             <prospectId>{$ctx:prospectId}</prospectId>
             <visitorId>{$ctx:visitorId}</visitorId>
             <limit>{$ctx:limit}</limit>
             <offset>{$ctx:offset}</offset>
             <sortBy>{$ctx:sortBy}</sortBy>
             <sortOrder>{$ctx:sortOrder}</sortOrder>
             <output>{$ctx:output}</output>
         </pardot.getVisitorActivities>
         <respond />
      </inSequence>
      <outSequence>
         <send />
      </outSequence>
   </target>
   <description />
</proxy>
  • No labels