Overview
Configuration is provided for establishing connections with the Pardot service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Configuration
Base URL address: https://pi.pardot.com/api.
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- email:
- password:
- user_key:
- api:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Pardot api_key={{=token.Access}}, user_key={{=connection.user.user_key}} -
format:
json
Based on resource template Base.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- Url
Template: ShortText.
- destination
Template: ShortText.
- campaign
Template: ShortText.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- embedCode
Template: LongText.
- embedUrl
Template: ShortText.
- baseContent
Template: LongText.
- basedOn
Template: ShortText.
- variation
Template: LongText. A composite field.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
- [Read] action
-
The result is extracted from:{{=_.map(parameters.id_list.split(','), function(id) { return connection.execute({ url: '/email/version/' + connection.user.api + '/do/read/id/' + id }).email; })}}.The action has the following user-defined parameters:
- id_list: Required. Specify comma separated list of email identifiers.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- subject
Template: ShortText.
- message
Field components:
- Contains the following components: html, text.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- [Read] action
-
The result is extracted from:{{=_.map(parameters.id_list.split(','), function(id) { return connection.execute({ url: '/email/version/' + connection.user.api + '/do/stats/id/' + id }).stats; })}}.The action has the following user-defined parameters:
- id_list: Required. Specify comma separated list of email identifiers.
- sent
Data type: DT_I4
- delivered
Data type: DT_I4
- total_clicks
Data type: DT_I4
- unique_clicks
Data type: DT_I4
- soft_bounced
Data type: DT_I4
- hard_bounced
Data type: DT_I4
- opt_outs
Data type: DT_I4
- spam_complaints
Data type: DT_I4
- opens
Data type: DT_I4
- unique_opens
Data type: DT_I4
- delivery_rate
Template: Percent.
- opens_rate
Template: Percent.
- click_through_rate
Template: Percent.
- unique_click_through_rate
Template: Percent.
- click_open_ratio
Template: Percent.
- opt_out_rate
Template: Percent.
- spam_complaint_rate
Template: Percent.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- street_address
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- postal_code
Template: ShortText.
- country
Template: ShortText.
Template: ShortText.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- prospect_id
Data type: DT_I4
- previous_stage_id
Data type: DT_I4
- next_stage_id
Data type: DT_I4
- seconds_elapsed
Data type: DT_I4
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- position
Data type: DT_I4
- is_locked
Template: Boolean.
Based on resource template Base.
The resource includes the fields from the List template.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- list_id
Data type: DT_I4
- prospect_id
Data type: DT_I4
- opted_out
Template: Boolean.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- campaign_id
Data type: DT_I4
- name
Template: ShortText.
- value
Data type: DT_I4
- probability
Data type: DT_I4
- type
Template: ShortText.
- stage
Template: ShortText.
- status
Template: ShortText.
- closed_at
Data type: DT_DBTIMESTAMP
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- name
Template: ShortText. A read-only field.
- matches
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/prospect/version/{{=connection.user.api}}/do/batchCreate.The following request parameters will be automatically processed:
-
application/json:
{{=(connection.user.api == 3) ? { prospects: { prospects: _.indexBy(batch, parameters.get('id', 'email')) } } : { prospects: { prospects: batch } } }}
Documentation: http://developer.pardot.com/kb/api-version-3/prospects/#endpoints-for-batch-processing.
-
application/json:
- [Update] action
-
Endpoint URL address:
/prospect/version/{{=connection.user.api}}/do/batchUpdate.The following request parameters will be automatically processed:
-
application/json:
{{=(connection.user.api == 3) ? { prospects: { prospects: _.indexBy(batch, parameters.get('id', 'email')) } } : { prospects: { prospects: batch } } }}
Documentation: http://developer.pardot.com/kb/api-version-3/prospects/#endpoints-for-batch-processing.
-
application/json:
- [Upsert] action
-
Endpoint URL address:
/prospect/version/{{=connection.user.api}}/do/batchUpsert.The following request parameters will be automatically processed:
-
application/json:
{{=(connection.user.api == 3) ? { prospects: { prospects: _.indexBy(batch, parameters.get('id', 'email')) } } : { prospects: { prospects: batch } } }}
Documentation: http://developer.pardot.com/kb/api-version-3/prospects/#endpoints-for-batch-processing.
-
application/json:
- id
A key field. Data type: DT_I4
- campaign_id
Data type: DT_I4
- salutation
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
Template: ShortText.
- password
Template: ShortText.
- company
Template: ShortText.
- prospect_account_id
Data type: DT_I4
- website
Template: ShortText.
- job_title
Template: ShortText.
- department
Template: ShortText.
- country
Template: ShortText.
- address_one
Template: ShortText.
- address_two
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- territory
Template: ShortText.
- zip
Template: ShortText.
- phone
Template: ShortText.
- fax
Template: ShortText.
- source
Template: ShortText.
- annual_revenue
Template: ShortText.
- employees
Template: ShortText.
- industry
Template: ShortText.
- years_in_business
Template: ShortText.
- comments
Data type: DT_WSTR ( length 4000 )
- notes
Data type: DT_WSTR ( length 4000 )
- score
Data type: DT_I4
- grade
Template: ShortText. A read-only field.
- last_activity_at
Data type: DT_DBTIMESTAMP A read-only field.
- recent_interaction
Template: ShortText. A read-only field.
- crm_lead_fid
Template: ShortText. A read-only field.
- crm_contact_fid
Template: ShortText. A read-only field.
- crm_owner_fid
Template: ShortText. A read-only field.
- crm_account_fid
Template: ShortText. A read-only field.
- salesforce_fid
Template: ShortText. A read-only field.
- crm_last_sync
Data type: DT_DBTIMESTAMP A read-only field.
- crm_url
Template: ShortText. A read-only field.
- is_do_not_email
Template: Boolean.
- is_do_not_call
Template: Boolean.
- opted_out
Template: Boolean. A read-only field.
- is_reviewed
Template: Boolean.
- is_starred
Template: Boolean.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
- campaign
Template: Campaign. A read-only field.
- last_activity
A read-only field. Field components:
-
Uses template:
VisitorActivity. - Contains the following components: visitor_activity.
-
Uses template:
- visitors
A read-only field. Field components:
- An array.
-
Uses template:
Visitor.
- visitor_activities
A read-only field. Field components:
- An array.
-
Uses template:
VisitorActivity.
- lists
A read-only field. Field components:
- An array.
- Contains the following components: id, did_opt_in, did_opt_out, created_at, updated_at, list.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
- [External]
-
The external fields URL address:
/{{=resource.object}}/version/{{=connection.user.api}}/do/describe. The external fields list is extracted from:{{=jsonPath(response, 'result.field[*].\@attributes')}}.- {{=external.id}}
Data type: {{=Pardot.getDataType(external.type)}} ( length 255 ) The gathered value is processed with
{{=(item[field.name] || {}).value}}expression.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- tag_id
Data type: DT_I4
- type
Template: ShortText.
- object_id
Data type: DT_I4
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
- id
A key field. Data type: DT_I4
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- job_title
Template: ShortText.
- role
Template: ShortText.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- visitor_id
Data type: DT_I4
- prospect_id
Data type: DT_I4
- visitor_page_view_count
Data type: DT_I4
- first_visitor_page_view_at
Data type: DT_DBTIMESTAMP
- last_visitor_page_view_at
Data type: DT_DBTIMESTAMP
- duration_in_seconds
Data type: DT_I4
- campaign_parameter
Template: ShortText.
- medium_parameter
Template: ShortText.
- source_parameter
Template: ShortText.
- content_parameter
Template: ShortText.
- term_parameter
Template: ShortText.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
The resource includes the fields from the Visitor template.
Based on resource template Base.
The resource includes the fields from the VisitorActivity template.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- url
Template: ShortText.
- title
Template: ShortText.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
- id
A key field. Data type: DT_I4
- referrer
Template: ShortText.
- vendor
Template: ShortText.
- type
Template: ShortText.
- query
Template: ShortText.
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
-
id_greater_than:
{{=parameters.iterator}}
-
offset:
- id
A key field. Data type: DT_I4
- prospect_id
Data type: DT_I4
- url
Template: ShortText.
- list_email_id
Data type: DT_I4
- drip_program_action_id
Data type: DT_I4
- email_template_id
Data type: DT_I4
- tracker_redirect_id
Data type: DT_I4
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- [Read] action
-
Endpoint URL address:
/{{=resource.object}}/version/{{=connection.user.api}}/do/query.
The result is extracted from:{{=response.result[resource.tag] || response.result[resource.object]}}.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
offset:
- [Create] action
-
Endpoint URL address:
/{{=resource.object}}/version/{{=connection.user.api}}/do/create.
The result is extracted from:{{=response[resource.tag] || response.result[resource.object]}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
Endpoint URL address:
/{{=resource.object}}/version/{{=connection.user.api}}/do/update/id/{{=item[resource.keyField]}}.
The result is extracted from:{{=response[resource.tag] || response.result[resource.object]}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Upsert] action
-
Endpoint URL address:
/{{=resource.object}}/version/{{=connection.user.api}}/do/upsert/id/{{=item[resource.keyField]}}.
The result is extracted from:{{=response[resource.tag] || response.result[resource.object]}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
Endpoint URL address:
/{{=resource.object}}/version/{{=connection.user.api}}/do/delete/id/{{=item[resource.keyField]}}.
The action uses POST method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- Boolean
Data type: DT_BOOL Before setting, the value is processed with
{{=value && value.toString().toLowerCase()}}expression.- Campaign
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- VisitorActivity
Field components:
-
Uses template:
ShortText. - Contains the following components: id, prospect_id, visitor_id, type, type_name, details, email_id, email_template_id, list_email_id, form_id, form_handler_id, site_search_query_id, landing_page_id, paid_search_id_id, multivariate_test_variation_id, visitor_page_view_id, file_id, campaign, created_at.
-
Uses template:
- Visitor
Field components:
-
Uses template:
ShortText. - Contains the following components: id, prospect_id, page_view_count, ip_address, hostname, browser, browser_version, operating_system, operating_system_version, language, screen_height, screen_width, is_flash_enabled, is_java_enabled, campaign_parameter, medium_parameter, source_parameter, content_parameter, term_parameter, created_at, updated_at.
-
Uses template:
- Percent
Data type: DT_R8 The gathered value is processed with
{{=value.replace('%', '')}}expression.- List
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, is_public, is_dynamic, title, description, is_crm_visible, created_at, updated_at.
-
Uses template:
What's New
- New: Included 'Visitory Activity' resource.
- New: Support for OAuth authentication.
- New: Support for reading from 'Email', 'Email Stats' resources.
- New: Authentication now placed in request header as required by service.
- New: Support for reading from 'Email Clicks' resource.
- Fixed: The definition for result extraction was incorrect.
- Fixed: Authentication token refresh may fail (Thank you, Porter).
- Fixed: Various fixes (Thank you Porter, Cheryl).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.