Autopilot integration summary

Stitch’s Autopilot integration replicates data using the Autopilot REST API . Refer to the Schema section for a list of objects available for replication.

Autopilot feature snapshot

A high-level look at Stitch's Autopilot (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on August 23, 2017

Supported by

Singer Community

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-autopilot

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Unsupported

Column selection

Unsupported

Select all

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Autopilot

Step 1: Retrieve your Autopilot API Key

  1. Sign into your Autopilot account.
  2. Click the gear (Settings) icon on the left side of the page.
  3. In the Settings menu, click Autopilot API.
  4. If you haven’t used the API before, you’ll need to generate a new key. Click the Generate button.
  5. Your API Key will display.

Make sure you keep this key safe, as it has access to your Autopilot account. If at any time your key is lost or compromised, you can click the Regenerate button to generate a new key. Remember to also update the key in Stitch or you’ll encounter connection issues.

Step 2: Add Autopilot as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Autopilot icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Autopilot” would create a schema called stitch_autopilot in the destination. Note: Schema names cannot be changed after you save the integration.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Autopilot integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Autopilot’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Autopilot integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Autopilot, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Autopilot table reference

contacts

The contacts table contains info about the contacts in your Autopilot account.

Any custom fields associated with contacts will also be replicated.

Replication Method

Key-based Incremental

Primary Key

contact_id

Replication Key

updated_at

Useful links

contacts schema on GitHub

Autopilot API method

Join contacts with on
lists_contacts
contacts.contact_id = lists_contacts.contact_id
contacts.lists = lists_contacts.list_id
smart_segments_contacts
contacts.contact_id = smart_segments_contacts.contact_id
lists
contacts.lists = lists.list_id

anywhere_form_submits

ARRAY

url

STRING

value

BOOLEAN

anywhere_page_visits

ARRAY

url

STRING

value

BOOLEAN

anywhere_utm

ARRAY

url

STRING

value

BOOLEAN

company

STRING

company_priority

BOOLEAN

contact_id

STRING

created_at

DATE-TIME

email

STRING

first_conversion_at

DATE-TIME

first_name

STRING

first_visit_at

DATE-TIME

last_name

STRING

lead_source

STRING

lists

ARRAY

mail_bounced

ARRAY

id

STRING

timestamp

DATE-TIME

mail_clicked

ARRAY

id

STRING

timestamp

DATE-TIME

mail_complained

ARRAY

id

STRING

timestamp

DATE-TIME

mail_hardbounced

ARRAY

id

STRING

timestamp

DATE-TIME

mail_opened

ARRAY

id

STRING

timestamp

DATE-TIME

mail_received

ARRAY

id

STRING

timestamp

DATE-TIME

mail_unsubscribed

ARRAY

id

STRING

timestamp

DATE-TIME

mailing_country

STRING

mailing_state

STRING

name

STRING

phone

STRING

salutation

STRING

status

STRING

twitter

STRING

updated_at

DATE-TIME

lists

The lists table contains info about the available lists in your Autopilot account.

Replication Method

Full Table

Primary Key

list_id

Useful links

lists schema on GitHub

Autopilot API method

Join lists with on
contacts
lists.list_id = contacts.lists
lists_contacts
lists.list_id = lists_contacts.list_id

list_id

STRING

title

STRING

lists_contacts

The lists_contacts table contains list and contact ID pairs, allowing you to create a list of all the contacts that belong to a given Autopilot list.

Replication Method

Full Table

Primary Keys

list_id

contact_id

Useful links

lists_contacts schema on GitHub

Autopilot API method

Join lists_contacts with on
contacts
lists_contacts.contact_id = contacts.contact_id
lists_contacts.list_id = contacts.lists
smart_segments_contacts
lists_contacts.contact_id = smart_segments_contacts.contact_id
lists
lists_contacts.list_id = lists.list_id

contact_id

STRING

list_id

STRING

smart_segments

The smart_segments table contains info about the smart segments in your Autopilot account.

Replication Method

Full Table

Primary Key

segment_id

Useful links

smart_segments schema on GitHub

Autopilot API method

Join smart_segments with on
smart_segments_contacts
smart_segments.segment_id = smart_segments_contacts.segment_id

segment_id

STRING

title

STRING

smart_segments_contacts

The smart_segments_contacts table contains segment and contact pairs, or the segments your contacts are associated with.

Replication Method

Full Table

Primary Keys

segment_id

contact_id

Useful links

smart_segments_contacts schema on GitHub

Autopilot API method

Join smart_segments_contacts with on
contacts
smart_segments_contacts.contact_id = contacts.contact_id
lists_contacts
smart_segments_contacts.contact_id = lists_contacts.contact_id
smart_segments
smart_segments_contacts.segment_id = smart_segments.segment_id

contact_id

STRING

segment_id

STRING


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.