Pardot (Salesforce Marketing Cloud Account Engagement)
Overview
This page contains the setup guide and reference information for the Pardot (Salesforce Marketing Cloud Account Engagement) source connector.
Prerequisites
- Pardot/Marketing Cloud Account Engagement account
- Pardot Business Unit ID
- Client ID
- Client Secret
- Refresh Token
Setup Guide
Required configuration options
-
Pardot Business Unit ID (
pardot_business_unit_id
): This value uniquely identifies your account, and can be found at Setup > Pardot > Pardot Account Setup -
Client ID (
client_id
): The Consumer Key that can be found when viewing your app in Salesforce -
Client Secret (
client_secret
): The Consumer Secret that can be found when viewing your app in Salesforce -
Refresh Token (
refresh_token
): Salesforce Refresh Token used for Airbyte to access your Salesforce account. If you don't know what this is, follow this guide to retrieve it.
Optional configuration options
-
Start Date (
start_date
): UTC date and time in the format2020-01-25T00:00:00Z
. Any data before this date will not be replicated. Defaults to2007-01-01T00:00:00Z
(the year Pardot was launched) -
Page Size Limit (
page_size
): The default page size to return; defaults to1000
(which is Pardot's maximum). Does not apply to the Email Clicks stream which uses the v4 API and is limited to 200 per page. -
Default Split Up Interval (
split_up_interval
): The default split up interval is used on incremental streams to prevent hitting Pardots limit of 100 pages per result (effectively 100K records on most endpoints). The default isP3M
, which will break incremental requests into three-month groupings. If you expect more than 100K records to be modified between syncs in a single endpoint, you can increase the granularity toP1M
,P14D
,P7D
,P3D
, orP1D
to reduce the maximum records to be paged through per split. For small accounts unlikely to hit the limit, decreasing the granularity toP6M
orP1Y
may increase the speed of those syncs, especially the initial backfill. -
Is Sandbox App? (
is_sandbox
): Whether or not the app is in a Salesforce sandbox. If you do not know what this is, assume it is false.
Supported Sync Modes
The Pardot source connector supports the following sync modes:
- Full Refresh
- Incremental
Incremental streams are based on the Pardot API's UpdatedAt
field when the object is updateable and the API supports it; otherwise CreatedAt
or Id
are used in that order of preference.
Performance Considerations
The Pardot connector should not run into Pardot API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
Due to timeouts on large accounts, the Split Up Interval (the time period used to page through incrementally) is surfaced as a configuration option. While the default should work for most accounts, large accounts may need to increase the granularity from the default. Similarly, small accounts may see faster initial syncs with a longer interval. See the Optional Configuration Options section for more details.
Supported Streams
Several output streams are available from this source. Unless noted otherwise, streams are from Pardot's v5 API:
- Account (Metadata) (full refresh)
- Campaigns (incremental)
- Custom Fields (incremental)
- Custom Redirects (full refresh)
- Dynamic Content (incremental)
- Dynamic Content Variations (incremental parent)
- Emails (incremental)
- Email Clicks (v4 API) (incremental)
- Engagement Studio Programs (incremental)
- Files (full refresh)
- Folders (full refresh)
- Folder Contents (incremental)
- Forms (full refresh)
- Form Fields (incremental)
- Form Handlers (full refresh)
- Form Handler Fields (full refresh)
- Landing Pages (incremental)
- Layout Templates (full refresh)
- Lifecycle Stages (incremental)
- Lifecycle Histories (incremental)
- Lists (incremental)
- List Emails (incremental)
- List Memberships (incremental)
- Opportunities (incremental)
- Prospects (incremental)
- Prospect Accounts (full refresh)
- Tags (incremental)
- Tracker Domains (full refresh)
- Users (incremental)
- Visitors (incremental)
- Visitor Activity (incremental)
- Visitor Page Views (incremental)
- Visits (incremental)
If there are more endpoints you'd like Airbyte to support, please create an issue.
Changelog
Version | Date | Pull Request | Subject |
---|---|---|---|
1.0.0 | 2023-12-12 | 49424 | Update streams to API V5. Fix auth flow |
0.2.0 | 2024-10-13 | 44528 | Migrate to LowCode then Manifest-only |
0.1.22 | 2024-10-12 | 46778 | Update dependencies |
0.1.21 | 2024-10-05 | 46441 | Update dependencies |
0.1.20 | 2024-09-28 | 46109 | Update dependencies |
0.1.19 | 2024-09-21 | 45799 | Update dependencies |
0.1.18 | 2024-09-14 | 45509 | Update dependencies |
0.1.17 | 2024-09-07 | 45307 | Update dependencies |
0.1.16 | 2024-08-31 | 45005 | Update dependencies |
0.1.15 | 2024-08-24 | 44728 | Update dependencies |
0.1.14 | 2024-08-17 | 44232 | Update dependencies |
0.1.13 | 2024-08-10 | 43471 | Update dependencies |
0.1.12 | 2024-08-03 | 43291 | Update dependencies |
0.1.11 | 2024-07-27 | 42649 | Update dependencies |
0.1.10 | 2024-07-20 | 42304 | Update dependencies |
0.1.9 | 2024-07-13 | 41886 | Update dependencies |
0.1.8 | 2024-07-10 | 41565 | Update dependencies |
0.1.7 | 2024-07-09 | 40884 | Update dependencies |
0.1.6 | 2024-06-26 | 40549 | Migrate off deprecated auth package |
0.1.5 | 2024-06-25 | 40339 | Update dependencies |
0.1.4 | 2024-06-22 | 40118 | Update dependencies |
0.1.3 | 2024-06-04 | 39087 | [autopull] Upgrade base image to v1.2.1 |
0.1.2 | 2024-05-21 | 38521 | [autopull] base image + poetry + up_to_date |
0.1.1 | 2022-12-16 | 19618 | Fix visitors stream |
0.1.0 | 2021-11-19 | 7091 | 🎉 New Source: Pardot |