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

Singer Community

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-impact

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Supported

Column selection

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

  1. Login to your Impact console.
  2. Click on the verticle ellipsis in the lower-left corner.
  3. Click Settings.
  4. On the settings page, locate the Technical section and click API.
  5. 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

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

  3. Click the Impact 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 Impact” would create a schema called stitch_impact in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Account SID field, paste the read-only Account SID you retrieved in Step 1.
  6. In the API Catalog field, select Advertisers.
  7. In the Auth Token field, paste the read-only Auth Token that you retrieved in Step 1.
  8. 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 sync

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:

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 tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your destination.

Check out the Schema section to learn more about the available tables in Impact and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

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.

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

Replication Method :

Key-based Incremental

Replication Key :

creation_date

Primary Key :

id

API endpoint :

Get action inquiries

The action_inquiries table contains info about a campaign’s action inquiries.

id
INTEGER

creation_date
DATE-TIME

action_id
STRING

Reference:

action_uri
STRING

auto_approval_date
DATE-TIME

campaign_id
INTEGER

Reference:

campaign_name
STRING

comments
ARRAY

comment
STRING

date
DATE-TIME

user
STRING

action_inquiries (table), comments (attribute)

expected_payout
NUMBER

final_payout
NUMBER

inquiry_type
STRING

media_partner_id
INTEGER

Reference:

media_partner_name
STRING

order_id
STRING

reject_reason
STRING

resolution_date
DATE-TIME

resolution_deadline_date
DATE-TIME

resolution_status
STRING

tracking_link
STRING

transaction_amount
NUMBER

transaction_date
DATE-TIME

uri
STRING


Replication Method :

Key-based Incremental

Replication Key :

update_date

Primary Key :

id

API endpoint :

List action updates

The action_updates table contains info about a campaign’s action updates.

id
STRING

update_date
DATE-TIME

action_date
DATE-TIME

action_id
STRING

Reference:

action_tracker_id
INTEGER

Reference:

action_uri
STRING

ad_id
INTEGER

Reference:

caller_id
STRING

campaign_id
INTEGER

Reference:

category
STRING

clearing_date
DATE-TIME

currency
STRING

customer_id
INTEGER

Reference:

customer_status
STRING

delta_amount
NUMBER

delta_payout
NUMBER

disposition
STRING

locking_date
DATE-TIME

media_partner_id
INTEGER

Reference:

order_id
STRING

quantity
INTEGER

shared_id
STRING

sku
STRING

state
STRING

state_detail
STRING

state_detail_description
STRING

uri
STRING


Replication Method :

Key-based Incremental

Replication Key :

event_date

Primary Key :

id

API endpoint :

Get actions

The actions table contains info about a campaign’s actions.

id
STRING

Reference:

event_date
DATE-TIME

action_tracker_id
INTEGER

Reference:

action_tracker_name
STRING

ad_id
INTEGER

Reference:

amount
NUMBER

caller_id
STRING

campaign_id
INTEGER

Reference:

campaign_name
STRING

cleared_date
DATE-TIME

client_cost
NUMBER

creation_date
DATE-TIME

currency
STRING

customer_area
STRING

customer_city
STRING

customer_country
STRING

customer_id
STRING

Reference:

customer_post_code
STRING

customer_region
STRING

customer_status
STRING

delta_amount
NUMBER

delta_payout
NUMBER

intended_amount
NUMBER

intended_payout
NUMBER

ip_address
STRING

locking_date
DATE-TIME

media_partner_id
INTEGER

Reference:

media_partner_name
STRING

note
STRING

order_id
STRING

payout
NUMBER

promo_code
STRING

referring_date
DATE-TIME

referring_domain
STRING

referring_type
STRING

shared_id
STRING

state
STRING

uri
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

List ads

The ads table contains info about ads.

id
INTEGER

Reference:

ad_code_template
STRING

ad_type
STRING

allow_deep_linking
BOOLEAN

banner_alternative_tag
STRING

bogo_buy_image_url
STRING

bogo_buy_name
STRING

bogo_buy_quantity
STRING

bogo_buy_scope
STRING

bogo_get_discount_amount
NUMBER

bogo_get_discount_currency
STRING

bogo_get_discount_percent
NUMBER

bogo_get_discount_type
STRING

bogo_get_image_url
STRING

bogo_get_name
STRING

bogo_get_quantity
STRING

bogo_get_scope
STRING

campaign_id
INTEGER

Reference:

campaign_name
STRING

coupon_allow_custom_promo_code
BOOLEAN

coupon_link_name
STRING

custom_ad_serving_url
STRING

customisation_charge
NUMBER

deal_categories
STRING

deal_default_promo_code
STRING

deal_description
STRING

deal_end_date
DATE-TIME

deal_id
STRING

Reference:

deal_name
STRING

deal_products
ARRAY

product_after_price_amount
NUMBER

product_after_price_currency
STRING

product_before_price_amount
NUMBER

product_before_price_currency
STRING

product_image_url
STRING

product_name
STRING

ads (table), deal_products (attribute)

deal_restricted_media_partner_groups
ARRAY

value
STRING

ads (table), deal_restricted_media_partner_groups (attribute)

deal_restricted_media_partners
ARRAY

value
STRING

ads (table), deal_restricted_media_partners (attribute)

deal_scope
STRING

deal_start_date
DATE-TIME

deal_state
STRING

deal_type
STRING

description
STRING

discount_amount
NUMBER

discount_currency
STRING

discount_maximum_percent
NUMBER

discount_percent
NUMBER

discount_percent_range_end
NUMBER

discount_percent_range_start
NUMBER

discount_type
STRING

get_html_code_type
STRING

gift
STRING

iab_ad_unit
STRING

labels
STRING

landing_page
STRING

language
STRING

limited_time_end_date
DATE-TIME

limited_time_start_date
DATE-TIME

link_text
STRING

maximum_savings_amount
NUMBER

maximum_savings_currency
STRING

minimum_purchase_amount
NUMBER

minimum_purchase_amount_currency
STRING

mobile_ready
BOOLEAN

name
STRING

phone_tracking
BOOLEAN

promo_code_tracking
BOOLEAN

purchase_limit_quantity
STRING

rebate_amount
NUMBER

rebate_currency
STRING

restricted_media_partner_groups
ARRAY

value
STRING

ads (table), restricted_media_partner_groups (attribute)

restricted_media_partners
ARRAY

value
STRING

ads (table), restricted_media_partners (attribute)

season
STRING

synch_ads_promo_codes
STRING

third_party_servable_ad_creative_height
STRING

third_party_servable_ad_creative_width
STRING

top_seller
BOOLEAN

uri
STRING


Replication Method :

Key-based Incremental

Replication Key :

submission_date

Primary Key :

batch_id

API endpoint :

Get API submissions

The api_submissions table contains info about API submissions.


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get campaigns

The campaigns table contains info about campaigns in your Impact account.

id
INTEGER

Reference:

categories
OBJECT

additional_category
STRING

additional_sub_categories
ARRAY

value
STRING

campaigns (table), additional_sub_categories (attribute)

primary_category
STRING

primary_sub_categories
ARRAY

value
STRING

campaigns (table), primary_sub_categories (attribute)
campaigns (table), categories (attribute)

company_contacts
ARRAY

direct_tracking_settings
OBJECT

session_window_length
INTEGER

unidentified_source_name
STRING

campaigns (table), direct_tracking_settings (attribute)

display_future_ads
BOOLEAN

display_servicing_agency
BOOLEAN

gateway_tracking_settings
OBJECT

campaign_tracking_template
STRING

deep_link_domains
STRING

deep_linking
BOOLEAN

default_landing_page
STRING

media_partner_tracking_template
STRING

ssl_support
BOOLEAN

third_party_gateway_query_string_parameters
STRING

third_party_gateway_url
STRING

unique_click_window_length
STRING

unique_click_window_type
STRING

campaigns (table), gateway_tracking_settings (attribute)

gift_card_payouts
BOOLEAN

identity_collapsing
STRING

impression_tracking
BOOLEAN

list_in_marketplace
BOOLEAN

long_description
STRING

mobile_ready_ads
BOOLEAN

name
STRING

promo_code_tracking
BOOLEAN

rating
INTEGER

resources
OBJECT

additional_related_links
ARRAY

company_homepage
STRING

example_landing_page
STRING

information_page
STRING

campaigns (table), resources (attribute)

search_keywords
STRING

shipping_regions
STRING

short_description
STRING

site_definition
STRING

state
STRING

third_party_impression_pixel
STRING

tracking_domain
STRING

trademark_bidding
BOOLEAN

view_through_crediting
BOOLEAN


Replication Method :

Full Table

Primary Key :

catalog_item_id

API endpoint :

List catalogs

The catalog_items table contains info about a catalog’s items.

catalog_item_id
STRING

additional_image_urls
ARRAY

value
STRING

catalog_items (table), additional_image_urls (attribute)

adult
BOOLEAN

age_group
STRING

asin
STRING

bullets
ARRAY

value
STRING

catalog_items (table), bullets (attribute)

catalog_id
INTEGER

Reference:

category
STRING

colors
ARRAY

value
STRING

catalog_items (table), colors (attribute)

condition
STRING

currency
STRING

current_price
NUMBER

description
STRING

estimated_ship_date
DATE-TIME

expiration_date
DATE-TIME

gender
STRING

gtin
STRING

gtin_type
STRING

image_url
STRING

inventory
NUMBER

is_parent
BOOLEAN

labels
ARRAY

value
STRING

catalog_items (table), labels (attribute)

launch_date
DATE-TIME

manufacturer
STRING

manufacturing_cost
NUMBER

material
STRING

mobile_url
STRING

money1
NUMBER

money2
NUMBER

money3
NUMBER

mpn
STRING

multi_pack
INTEGER

name
STRING

numeric1
NUMBER

numeric2
NUMBER

numeric3
NUMBER

original_format_category
STRING

original_format_category_id
INTEGER

original_price
NUMBER

parent_name
STRING

parent_sku
STRING

pattern
STRING

product_bid
NUMBER

shipping_height
NUMBER

shipping_label
STRING

shipping_length
NUMBER

shipping_length_unit
STRING

shipping_rate
NUMBER

shipping_weight
NUMBER

shipping_weight_unit
STRING

shipping_width
NUMBER

size
STRING

size_unit
STRING

stock_availability
STRING

text1
STRING

text2
STRING

text3
STRING

uri
STRING

url
STRING

weight
NUMBER

weight_unit
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

List catalogs

The catalogs table contains info about the catalogs in your Impact account.


Replication Method :

Key-based Incremental

Replication Key :

event_date

Primary Key :

id

API endpoint :

Get clicks

The clicks table contains info about a campaign’s clicks.

id
STRING

event_date
DATE-TIME

ad_campaign
STRING

ad_group
STRING

ad_id
INTEGER

Reference:

ad_name
STRING

ad_type
STRING

bid_keyword
STRING

browser
STRING

campaign_id
INTEGER

Reference:

campaign_name
STRING

channel
STRING

cpc_bid
NUMBER

customer_area
STRING

customer_city
STRING

customer_country
STRING

customer_region
STRING

deal_name
STRING

deal_scope
STRING

deal_type
STRING

device_family
STRING

device_type
STRING

ip_address
STRING

keyword
STRING

landing_page_url
STRING

match_type
STRING

media_id
INTEGER

Reference:

media_name
STRING

os
STRING

payout
NUMBER

product_sku
STRING

profile_id
STRING

referring_domain
STRING

referring_url
STRING

search_text
STRING

shared_id
STRING

traffic_category
STRING

traffic_source
STRING

unique_click
BOOLEAN


company_information

Replication Method :

Full Table

Primary Key :

company_name

API endpoint :

Get company info

The company_information table contains details about companies.

company_name
STRING

billing_address
OBJECT

address_line1
STRING

address_line2
STRING

city
STRING

country
STRING

postal_code
STRING

state
STRING

company_information (table), billing_address (attribute)

commercial_contact
OBJECT

cell_phone_number
STRING

cell_phone_number_country
STRING

email
STRING

name
STRING

user_id
INTEGER

work_phone_number
STRING

work_phone_number_country
STRING

company_information (table), commercial_contact (attribute)

corporate_address
OBJECT

address_line1
STRING

address_line2
STRING

city
STRING

country
STRING

postal_code
STRING

state
STRING

company_information (table), corporate_address (attribute)

currency
STRING

ein_ssn_foreign_tax_id
STRING

financial_contact
OBJECT

cell_phone_number
STRING

cell_phone_number_country
STRING

email
STRING

name
STRING

user_id
INTEGER

work_phone_number
STRING

work_phone_number_country
STRING

company_information (table), financial_contact (attribute)

indirect_tax_number
STRING

industry
OBJECT

industry_id
INTEGER

industry_name
STRING

company_information (table), industry (attribute)

minimum_contact_rating
INTEGER

organization_type
STRING

primary_phone_number
STRING

primary_phone_number_country
STRING

registered_for_indirect_tax
BOOLEAN

secondary_phone_number
STRING

secondary_phone_number_country
STRING

technical_contact
OBJECT

cell_phone_number
STRING

cell_phone_number_country
STRING

email
STRING

name
STRING

user_id
INTEGER

work_phone_number
STRING

work_phone_number_country
STRING

company_information (table), technical_contact (attribute)

timezone
STRING

uri
STRING

website
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get contacts

The contacts table contains info about a campaign’s contacts.

id
STRING

Reference:

accounts
ARRAY, OBJECT

id
INTEGER

name
STRING

contacts (table), accounts (attribute)

campaign_id
INTEGER

Reference:

cellphone_number
STRING

cellphone_number_country
STRING

email_address
STRING

first_name
STRING

labels
ARRAY

last_name
STRING

profile_image
STRING

title
STRING

uri
STRING

work_phone_number
INTEGER

work_phone_number_country
STRING


Replication Method :

Full Table

Primary Key :

campaign_id : customer_id : model_id

API endpoint :

Get conversion paths

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
INTEGER

Reference:

customer_id
INTEGER

Reference:

model_id
INTEGER

campaign_name
STRING

channel_count
INTEGER

cost
NUMBER

events
ARRAY

id
STRING

type
STRING

sub_type
STRING

event_date
DATE-TIME

step
INTEGER

position_type
STRING

site_version
STRING

site_category
STRING

landing_page
STRING

customer_status
STRING

customer_post_code
STRING

customer_area
STRING

customer_city
STRING

customer_region
STRING

customer_country
STRING

device_type
STRING

device_family
STRING

browser
STRING

os
STRING

profile_id
STRING

fingerprint
STRING

platform
STRING

media_id
INTEGER

Reference:

media_name
STRING

channel
STRING

ad_distribution_type
STRING

ad_campaign
STRING

ad_group
STRING

ad_id
INTEGER

Reference:

ad_name
STRING

deal_name
STRING

deal_type
STRING

deal_scope
STRING

keyword
STRING

match_type
STRING

traffic_type
STRING

ad_site_location
STRING

sub_id_1
INTEGER

sub_id_2
INTEGER

sub_id_3
INTEGER

shared_id
STRING

referring_url
STRING

attributed_credit
NUMBER

attributed_revenue
NUMBER

action_id
STRING

Reference:

action_date
DATE-TIME

action_tracker_id
INTEGER

Reference:

action_tracker_name
STRING

app_package_name
STRING

app_name
STRING

app_version
STRING

phone_number
STRING

order_id
STRING

promocode
STRING

amount
NUMBER

payout
NUMBER

order_margin
NUMBER

order_discount
NUMBER

order_shipping
NUMBER

order_tax
NUMBER

order_vat
NUMBER

order_subtotal
NUMBER

note
STRING

text_1
STRING

text_2
STRING

text_3
STRING

numeric_1
NUMBER

numeric_2
NUMBER

numeric_3
NUMBER

money_1
NUMBER

money_2
NUMBER

money_3
NUMBER

date_1
DATE

date_2
DATE

date_3
DATE

conversion_paths (table), events (attribute)

latency
NUMBER

media_count
INTEGER

model_name
STRING

referral_counts
ARRAY

count
INTEGER

type
STRING

conversion_paths (table), referral_counts (attribute)

revenue
NUMBER

steps
INTEGER

uri
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get deals

The deals table contains info about the deals in your Impact account.

id
INTEGER

Reference:

bogo_buy_image_url
STRING

bogo_buy_name
STRING

bogo_buy_quantity
STRING

bogo_buy_scope
STRING

bogo_get_discount_amount
NUMBER

bogo_get_discount_currency
STRING

bogo_get_discount_percent
INTEGER

bogo_get_discount_type
STRING

bogo_get_image_url
STRING

bogo_get_name
STRING

bogo_get_quantity
STRING

bogo_get_scope
STRING

campaign_id
INTEGER

Reference:

categories
STRING

default_promo_code
STRING

description
STRING

discount_amount
NUMBER

discount_currency
STRING

discount_maximum_percent
INTEGER

discount_percent
INTEGER

discount_percent_range_end
INTEGER

discount_percent_range_start
INTEGER

discount_type
STRING

end_date
DATE-TIME

gift
STRING

maximum_savings_amount
NUMBER

maximum_savings_currency
STRING

minimum_purchase_amount
NUMBER

minimum_purchase_amount_currency
STRING

name
STRING

products
ARRAY

product_after_price_amount
NUMBER

product_after_price_currency
NUMBER

product_before_price_amount
NUMBER

product_before_price_currency
NUMBER

product_image_url
STRING

product_name
STRING

deals (table), products (attribute)

purchase_limit_quantity
STRING

rebate_amount
NUMBER

rebate_currency
STRING

restricted_media_partner_groups
ARRAY

value
STRING

deals (table), restricted_media_partner_groups (attribute)

restricted_media_partners
ARRAY

value
STRING

deals (table), restricted_media_partners (attribute)

scope
STRING

start_date
DATE-TIME

state
STRING

synch_ads_promo_codes
STRING

type
STRING

uri
STRING


exception_list_items

Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get exception list items

The exception_list_items table contains info about an exception list’s items.

id
INTEGER

created_date
DATE-TIME

list_id
INTEGER

Reference:

match_mode
STRING

name
STRING

uri
STRING

value
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get exception lists

The exception_lists table contains info about exception lists.


ftp_file_submissions

Replication Method :

Key-based Incremental

Replication Key :

submission_date

Primary Key :

batch_id

API endpoint :

Get FTP file submissions

The ftp_file_submissions table contains info about FTP file submissions.

batch_id
STRING

submission_date
DATE-TIME

account_id
INTEGER

Reference:

completion_date
DATE-TIME

errors_uri
STRING

file_name
STRING

status
STRING

total_errors
STRING

total_records
INTEGER

type
STRING

uri
STRING


Replication Method :

Key-based Incremental

Replication Key :

created_date

Primary Key :

id

API endpoint :

Get invoices

The invoices table contains info about the invoices in your Impact account.

id
STRING

created_date
DATE-TIME

currency
STRING

line_items
ARRAY

media_id
INTEGER

Reference:

media_name
STRING

pdf
STRING

total_amount
NUMBER

total_vat_amount
NUMBER


media_partner_groups

Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get media partner groups

The media_partner_groups table contains info about a campaign’s media partner groups.


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get media partners

The media_partners table contains info about the media partners in your Impact account.