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/.

Working with Campaigns in Pardot

Owned by Former user (Deleted)
Last updated: Oct 13, 2016
4 min read

The getCampaigns operation retrieves the details of all campaigns.

getCampaigns
<pardot.getCampaigns>
    <createdAfter>{$ctx:createdAfter}</createdAfter>
    <createdBefore>{$ctx:createdBefore}</createdBefore>
    <idGreaterThan>{$ctx:idGreaterThan}</idGreaterThan>
    <idLessThan>{$ctx:idLessThan}</idLessThan>
    <updatedAfter>{$ctx:updatedAfter}</updatedAfter>
    <updatedBefore>{$ctx:updatedBefore}</updatedBefore>
    <name>{$ctx:name}</name>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <sortBy>{$ctx:sortBy}</sortBy>
    <sortOrder>{$ctx:sortOrder}</sortOrder>
</pardot.getCampaigns>
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.
  • idLessThan: Selects campaigns with IDs less than the specified integer.
  • updatedAfter:  Selects campaigns that were last updated after the specified time.
  • updatedBefore:  Selects campaigns that were last updated before the specified time. 
  • name:  Searches for campaigns a name exactly matching the given name.
  • limit:  Specifies the number of results to be returned.
  • offset:  Specifies the first matching campaign 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.
Sample request

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

Sample Request for getCampaigns
<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/campaigns/

Sample configuration

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

Sample Proxy
<proxy xmlns="http://ws.apache.org/ns/synapse" name="getCampaigns" 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.getCampaigns>
            <createdAfter>{$ctx:createdAfter}</createdAfter>
            <createdBefore>{$ctx:createdBefore}</createdBefore>
            <idGreaterThan>{$ctx:idGreaterThan}</idGreaterThan>
            <idLessThan>{$ctx:idLessThan}</idLessThan>
            <updatedAfter>{$ctx:updatedAfter}</updatedAfter>
            <updatedBefore>{$ctx:updatedBefore}</updatedBefore>
            <name>{$ctx:name}</name>
            <limit>{$ctx:limit}</limit>
            <offset>{$ctx:offset}</offset>
            <sortBy>{$ctx:sortBy}</sortBy>
            <sortOrder>{$ctx:sortOrder}</sortOrder>
         </pardot.getCampaigns>
         <respond />
      </inSequence>
      <outSequence>
         <send />
      </outSequence>
   </target>
   <description />
</proxy>