Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

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

The getVisitorActivities operation retrieves the details of all visitor activities .

Code Block
languagexml
titlegetVisitorActivities
<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 prospects based on whether they are assigned.
  • campaignIdtype: Selects visitor activities 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 visitor activities based on whether they have been deleted.Default value: falseonly visitor activities generated by the custom redirect with the specified ID.
  • emailId: Selects only visitor activities that have a grade equal to generated by the email with the specified gradeID.
  • fileId: Selects only visitor activities that have a grade greater than generated by the file with the specified gradeID.
  • formId: Selects only visitor activities that have a grade less than generated by the form with the specified gradeID.
  • formHandlerId: Selects only visitor activities based on whether they are starredgenerated by the form handler with the specified ID.
  • landingPageId: Selects only visitor activities that have been active before generated by the landing page with the specified timeID.
  • prospectId: Selects only visitor activities that have been active after associated with the prospect with the specified timeID.
  • visitorId: Selects only visitor activities that have never been activeassociated with the visitor with the specified ID.
  • 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.

...

Related Pardot documentation

http://developer.pardot.com/kb/api-version-4/visitor-activities/

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

...

Code Block
languagexml
titleSample 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="assignedprospectOnly" expression="//assignedprospectOnly" />
         <property name="assignedToUsertype" expression="//assignedToUsertype" />
         <property name="deletedcampaignId" expression="//deletedcampaignId" />
         <property name="gradeEqualTocustomUrlId" expression="//gradeEqualTocustomUrlId" />
         <property name="gradeGreaterThanemailId" expression="//gradeGreaterThanemailId" />
         <property name="gradeLessThanfileId" expression="//gradeLessThanfileId" />
         <property name="isStarredformId" expression="//isStarredformId" />
         <property name="lastActivityBeforeformHandlerId" expression="//lastActivityBeforeformHandlerId" />
         <property name="lastActivityAfterlandingPageId" expression="//lastActivityAfterlandingPageId" />
         <property name="lastActivityNeverprospectId" expression="//lastActivityNeverprospectId" />
         <property name="listIdvisitorId" 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" 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" />
         <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>