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 2 Next »

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 visitor activities based on whether they are assigned.
  • campaignId: Selects visitor activities based on whether they are assigned to a specified user.
  • customUrlId: Selects visitor activities based on whether they have been deleted.Default value: false.
  • emailId: Selects visitor activities that have a grade equal to the specified grade.
  • fileId: Selects visitor activities that have a grade greater than the specified grade.
  • formId: Selects visitor activities that have a grade less than the specified grade.
  • formHandlerId: Selects visitor activities based on whether they are starred.
  • landingPageId: Selects visitor activities that have been active before the specified time.
  • prospectId: Selects visitor activities that have been active after the specified time.
  • visitorId: Selects visitor activities that have never been active.
  • limit:  Specifies the number of results to be returned.
  • offset:  Specifies the first matching visitor activity 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="assigned" expression="//assigned" />
         <property name="assignedToUser" expression="//assignedToUser" />
         <property name="deleted" expression="//deleted" />
         <property name="gradeEqualTo" expression="//gradeEqualTo" />
         <property name="gradeGreaterThan" expression="//gradeGreaterThan" />
         <property name="gradeLessThan" expression="//gradeLessThan" />
         <property name="isStarred" expression="//isStarred" />
         <property name="lastActivityBefore" expression="//lastActivityBefore" />
         <property name="lastActivityAfter" expression="//lastActivityAfter" />
         <property name="lastActivityNever" expression="//lastActivityNever" />
         <property name="listId" expression="//listId" />
         <property name="scoreEqualTo" expression="//scoreEqualTo" />
         <property name="scoreGreaterThan" expression="//scoreGreaterThan" />
         <property name="scoreLessThan" expression="//scoreLessThan" />
         <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" />
         <property name="output" expression="//output" />
         <property name="fields" expression="//fields" />
         <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