This integration is powered by Singer's Impact tap. For support, visit the GitHub repo or join the Singer Slack.
Impact integration summary
Stitch’s Impact integration replicates data using the Impact Radius API and the Advertisers API catalog.
Refer to the Schema section for a list of objects available for replication.
Impact feature snapshot
A high-level look at Stitch's Impact (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on July 1, 2020 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Impact
Impact setup requirements
To set up Impact in Stitch, you need:
-
To have API access enabled for your Impact account. To do this, login to the Impact console. Locate the gear icon and then click Technical Settings > API Access. Click Enable API Access Now.
Step 1: Retrieve your Impact account SID and auth token
- Login to your Impact console.
- Click on the verticle ellipsis in the lower-left corner.
- Click Settings.
- On the settings page, locate the Technical section and click API.
- Copy the read-only versions of your Account SID and Auth Token, and save it in a safe place.
Step 2: Add Impact as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Impact icon.
-
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 Impact” would create a schema called
stitch_impact
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Account SID field, paste the read-only Account SID you retrieved in Step 1.
- In the API Catalog field, select
Advertisers
. - In the Auth Token field, paste the read-only Auth Token that you retrieved in Step 1.
-
Optional: In the Model ID field, enter your model ID. This is used in the
conversion_paths
table to extract data about conversions from clicks to conversion purchases.To access your model ID, contact Impact Radius Support or open an help desk request with Impact.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Impact integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Impact’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.
Impact integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
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.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Impact integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Impact, 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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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.
Impact table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Impact integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
actions
Replication Method : |
Key-based Incremental |
Replication Key |
event_date |
Primary Key |
id |
API endpoint : |
The actions
table contains info about a campaign’s actions.
id
Reference: |
event_date
|
action_tracker_id
Reference: |
action_tracker_name
|
ad_id
Reference: |
amount
|
caller_id
|
campaign_id
Reference:
|
campaign_name
|
cleared_date
|
client_cost
|
creation_date
|
currency
|
customer_area
|
customer_city
|
customer_country
|
customer_id
Reference: |
customer_post_code
|
customer_region
|
customer_status
|
delta_amount
|
delta_payout
|
intended_amount
|
intended_payout
|
ip_address
|
locking_date
|
media_partner_id
Reference: |
media_partner_name
|
note
|
order_id
|
payout
|
promo_code
|
referring_date
|
referring_domain
|
referring_type
|
shared_id
|
state
|
uri
|
action_inquiries
Replication Method : |
Key-based Incremental |
Replication Key |
creation_date |
Primary Key |
id |
API endpoint : |
The action_inquiries
table contains info about a campaign’s action inquiries.
id
|
|||
creation_date
|
|||
action_id
Reference: |
|||
action_uri
|
|||
auto_approval_date
|
|||
campaign_id
Reference:
|
|||
campaign_name
|
|||
comments
|
|||
expected_payout
|
|||
final_payout
|
|||
inquiry_type
|
|||
media_partner_id
Reference: |
|||
media_partner_name
|
|||
order_id
|
|||
reject_reason
|
|||
resolution_date
|
|||
resolution_deadline_date
|
|||
resolution_status
|
|||
tracking_link
|
|||
transaction_amount
|
|||
transaction_date
|
|||
uri
|
action_updates
Replication Method : |
Key-based Incremental |
Replication Key |
update_date |
Primary Key |
id |
API endpoint : |
The action_updates
table contains info about a campaign’s action updates.
id
|
update_date
|
action_date
|
action_id
Reference: |
action_tracker_id
Reference: |
action_uri
|
ad_id
Reference: |
caller_id
|
campaign_id
Reference:
|
category
|
clearing_date
|
currency
|
customer_id
Reference: |
customer_status
|
delta_amount
|
delta_payout
|
disposition
|
locking_date
|
media_partner_id
Reference: |
order_id
|
quantity
|
shared_id
|
sku
|
state
|
state_detail
|
state_detail_description
|
uri
|
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The ads
table contains info about ads.
id
Reference: |
||||||
ad_code_template
|
||||||
ad_type
|
||||||
allow_deep_linking
|
||||||
banner_alternative_tag
|
||||||
bogo_buy_image_url
|
||||||
bogo_buy_name
|
||||||
bogo_buy_quantity
|
||||||
bogo_buy_scope
|
||||||
bogo_get_discount_amount
|
||||||
bogo_get_discount_currency
|
||||||
bogo_get_discount_percent
|
||||||
bogo_get_discount_type
|
||||||
bogo_get_image_url
|
||||||
bogo_get_name
|
||||||
bogo_get_quantity
|
||||||
bogo_get_scope
|
||||||
campaign_id
Reference:
|
||||||
campaign_name
|
||||||
coupon_allow_custom_promo_code
|
||||||
coupon_link_name
|
||||||
custom_ad_serving_url
|
||||||
customisation_charge
|
||||||
deal_categories
|
||||||
deal_default_promo_code
|
||||||
deal_description
|
||||||
deal_end_date
|
||||||
deal_id
Reference: |
||||||
deal_name
|
||||||
deal_products
|
||||||
deal_restricted_media_partner_groups
|
||||||
deal_restricted_media_partners
|
||||||
deal_scope
|
||||||
deal_start_date
|
||||||
deal_state
|
||||||
deal_type
|
||||||
description
|
||||||
discount_amount
|
||||||
discount_currency
|
||||||
discount_maximum_percent
|
||||||
discount_percent
|
||||||
discount_percent_range_end
|
||||||
discount_percent_range_start
|
||||||
discount_type
|
||||||
get_html_code_type
|
||||||
gift
|
||||||
iab_ad_unit
|
||||||
labels
|
||||||
landing_page
|
||||||
language
|
||||||
limited_time_end_date
|
||||||
limited_time_start_date
|
||||||
link_text
|
||||||
maximum_savings_amount
|
||||||
maximum_savings_currency
|
||||||
minimum_purchase_amount
|
||||||
minimum_purchase_amount_currency
|
||||||
mobile_ready
|
||||||
name
|
||||||
phone_tracking
|
||||||
promo_code_tracking
|
||||||
purchase_limit_quantity
|
||||||
rebate_amount
|
||||||
rebate_currency
|
||||||
restricted_media_partner_groups
|
||||||
restricted_media_partners
|
||||||
season
|
||||||
synch_ads_promo_codes
|
||||||
third_party_servable_ad_creative_height
|
||||||
third_party_servable_ad_creative_width
|
||||||
top_seller
|
||||||
uri
|
api_submissions
Replication Method : |
Key-based Incremental |
Replication Key |
submission_date |
Primary Key |
batch_id |
API endpoint : |
The api_submissions
table contains info about API submissions.
batch_id
|
submission_date
|
account_id
Reference: |
action_tracker_id
Reference: |
campaign_id
Reference:
|
completion_date
|
error_reason
|
error_type
|
event_code
|
media_partner_id
Reference: |
order_id
|
payload
|
status
|
type
|
uri
|
campaigns
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The campaigns
table contains info about campaigns in your Impact account.
id
Reference:
|
||||||||||
categories
|
||||||||||
company_contacts
|
||||||||||
direct_tracking_settings
|
||||||||||
display_future_ads
|
||||||||||
display_servicing_agency
|
||||||||||
gateway_tracking_settings
|
||||||||||
gift_card_payouts
|
||||||||||
identity_collapsing
|
||||||||||
impression_tracking
|
||||||||||
list_in_marketplace
|
||||||||||
long_description
|
||||||||||
mobile_ready_ads
|
||||||||||
name
|
||||||||||
promo_code_tracking
|
||||||||||
rating
|
||||||||||
resources
|
||||||||||
search_keywords
|
||||||||||
shipping_regions
|
||||||||||
short_description
|
||||||||||
site_definition
|
||||||||||
state
|
||||||||||
third_party_impression_pixel
|
||||||||||
tracking_domain
|
||||||||||
trademark_bidding
|
||||||||||
view_through_crediting
|
catalogs
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The catalogs
table contains info about the catalogs in your Impact account.
id
Reference: |
advertiser_id
Reference: |
campaign_id
Reference:
|
date_last_updated
|
filename
|
items_uri
|
name
|
number_of_items
|
status
|
upload_method
|
uri
|
catalog_items
Replication Method : |
Full Table |
Primary Key |
catalog_item_id |
API endpoint : |
The catalog_items
table contains info about a catalog’s items.
catalog_item_id
|
|
additional_image_urls
|
|
adult
|
|
age_group
|
|
asin
|
|
bullets
|
|
catalog_id
Reference: |
|
category
|
|
colors
|
|
condition
|
|
currency
|
|
current_price
|
|
description
|
|
estimated_ship_date
|
|
expiration_date
|
|
gender
|
|
gtin
|
|
gtin_type
|
|
image_url
|
|
inventory
|
|
is_parent
|
|
labels
|
|
launch_date
|
|
manufacturer
|
|
manufacturing_cost
|
|
material
|
|
mobile_url
|
|
money1
|
|
money2
|
|
money3
|
|
mpn
|
|
multi_pack
|
|
name
|
|
numeric1
|
|
numeric2
|
|
numeric3
|
|
original_format_category
|
|
original_format_category_id
|
|
original_price
|
|
parent_name
|
|
parent_sku
|
|
pattern
|
|
product_bid
|
|
shipping_height
|
|
shipping_label
|
|
shipping_length
|
|
shipping_length_unit
|
|
shipping_rate
|
|
shipping_weight
|
|
shipping_weight_unit
|
|
shipping_width
|
|
size
|
|
size_unit
|
|
stock_availability
|
|
text1
|
|
text2
|
|
text3
|
|
uri
|
|
url
|
|
weight
|
|
weight_unit
|
clicks
Replication Method : |
Key-based Incremental |
Replication Key |
event_date |
Primary Key |
id |
API endpoint : |
The clicks
table contains info about a campaign’s clicks.
id
|
event_date
|
ad_campaign
|
ad_group
|
ad_id
Reference: |
ad_name
|
ad_type
|
bid_keyword
|
browser
|
campaign_id
Reference:
|
campaign_name
|
channel
|
cpc_bid
|
customer_area
|
customer_city
|
customer_country
|
customer_region
|
deal_name
|
deal_scope
|
deal_type
|
device_family
|
device_type
|
ip_address
|
keyword
|
landing_page_url
|
match_type
|
media_id
Reference: |
media_name
|
os
|
payout
|
product_sku
|
profile_id
|
referring_domain
|
referring_url
|
search_text
|
shared_id
|
traffic_category
|
traffic_source
|
unique_click
|
company_information
Replication Method : |
Full Table |
Primary Key |
company_name |
API endpoint : |
The company_information
table contains details about companies.
company_name
|
|||||||
billing_address
|
|||||||
commercial_contact
|
|||||||
corporate_address
|
|||||||
currency
|
|||||||
ein_ssn_foreign_tax_id
|
|||||||
financial_contact
|
|||||||
indirect_tax_number
|
|||||||
industry
|
|||||||
minimum_contact_rating
|
|||||||
organization_type
|
|||||||
primary_phone_number
|
|||||||
primary_phone_number_country
|
|||||||
registered_for_indirect_tax
|
|||||||
secondary_phone_number
|
|||||||
secondary_phone_number_country
|
|||||||
technical_contact
|
|||||||
timezone
|
|||||||
uri
|
|||||||
website
|
contacts
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The contacts
table contains info about a campaign’s contacts.
id
Reference: |
accounts
|
campaign_id
Reference:
|
cellphone_number
|
cellphone_number_country
|
email_address
|
first_name
|
labels
|
last_name
|
profile_image
|
title
|
uri
|
work_phone_number
|
work_phone_number_country
|
conversion_paths
Replication Method : |
Full Table |
Primary Key |
campaign_id : customer_id : model_id |
API endpoint : |
The conversion_paths
table contains info about a campaign’s conversions.
Note: Your Model ID must be provided in the integration’s settings to replicate data for this table.
campaign_id
Reference:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id
Reference: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
model_id
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_name
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channel_count
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cost
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
events
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
latency
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
media_count
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
model_name
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
referral_counts
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
revenue
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
steps
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uri
|
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The deals
table contains info about the deals in your Impact account.
id
Reference: |
||||||
bogo_buy_image_url
|
||||||
bogo_buy_name
|
||||||
bogo_buy_quantity
|
||||||
bogo_buy_scope
|
||||||
bogo_get_discount_amount
|
||||||
bogo_get_discount_currency
|
||||||
bogo_get_discount_percent
|
||||||
bogo_get_discount_type
|
||||||
bogo_get_image_url
|
||||||
bogo_get_name
|
||||||
bogo_get_quantity
|
||||||
bogo_get_scope
|
||||||
campaign_id
Reference:
|
||||||
categories
|
||||||
default_promo_code
|
||||||
description
|
||||||
discount_amount
|
||||||
discount_currency
|
||||||
discount_maximum_percent
|
||||||
discount_percent
|
||||||
discount_percent_range_end
|
||||||
discount_percent_range_start
|
||||||
discount_type
|
||||||
end_date
|
||||||
gift
|
||||||
maximum_savings_amount
|
||||||
maximum_savings_currency
|
||||||
minimum_purchase_amount
|
||||||
minimum_purchase_amount_currency
|
||||||
name
|
||||||
products
|
||||||
purchase_limit_quantity
|
||||||
rebate_amount
|
||||||
rebate_currency
|
||||||
restricted_media_partner_groups
|
||||||
restricted_media_partners
|
||||||
scope
|
||||||
start_date
|
||||||
state
|
||||||
synch_ads_promo_codes
|
||||||
type
|
||||||
uri
|
exception_lists
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The exception_lists
table contains info about exception lists.
id
Reference: |
action_trackers
|
campaign_id
Reference:
|
created_date
|
deactivation_date
|
items_uri
|
name
|
number_of_items
|
state
|
type
|
uri
|
exception_list_items
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The exception_list_items
table contains info about an exception list’s items.
id
|
created_date
|
list_id
Reference: |
match_mode
|
name
|
uri
|
value
|
ftp_file_submissions
Replication Method : |
Key-based Incremental |
Replication Key |
submission_date |
Primary Key |
batch_id |
API endpoint : |
The ftp_file_submissions
table contains info about FTP file submissions.
batch_id
|
submission_date
|
account_id
Reference: |
completion_date
|
errors_uri
|
file_name
|
status
|
total_errors
|
total_records
|
type
|
uri
|
invoices
Replication Method : |
Key-based Incremental |
Replication Key |
created_date |
Primary Key |
id |
API endpoint : |
The invoices
table contains info about the invoices in your Impact account.
id
|
|||||||||||
created_date
|
|||||||||||
currency
|
|||||||||||
line_items
|
|||||||||||
media_id
Reference: |
|||||||||||
media_name
|
|||||||||||
pdf
|
|||||||||||
total_amount
|
|||||||||||
total_vat_amount
|
media_partners
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The media_partners
table contains info about the media partners in your Impact account.
id
Reference: |
|||||
address_line1
|
|||||
address_line2
|
|||||
campaigns
|
|||||
city
|
|||||
contact
|
|||||
country
|
|||||
country_state
|
|||||
currency
|