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

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

  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 replication start date

The Sync Historical Data setting defines the starting date for your Impact 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 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 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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue 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.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. 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.

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

action_inquiries

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

creation_date

Useful links

action_inquiries schema on GitHub

Impact API method

Join action_inquiries with on
action_updates
action_inquiries.action_id = action_updates.action_id
action_inquiries.campaign_id = action_updates.campaign_id
action_inquiries.media_partner_id = action_updates.media_partner_id
actions
action_inquiries.action_id = actions.id
action_inquiries.campaign_id = actions.campaign_id
action_inquiries.media_partner_id = actions.media_partner_id
conversion_paths
action_inquiries.action_id = conversion_paths.events.action_id
action_inquiries.campaign_id = conversion_paths.campaign_id
ads
action_inquiries.campaign_id = ads.campaign_id
api_submissions
action_inquiries.campaign_id = api_submissions.campaign_id
action_inquiries.media_partner_id = api_submissions.media_partner_id
campaigns
action_inquiries.campaign_id = campaigns.id
catalogs
action_inquiries.campaign_id = catalogs.campaign_id
clicks
action_inquiries.campaign_id = clicks.campaign_id
contacts
action_inquiries.campaign_id = contacts.campaign_id
deals
action_inquiries.campaign_id = deals.campaign_id
exception_lists
action_inquiries.campaign_id = exception_lists.campaign_id
invoices
action_inquiries.campaign_id = invoices.line_items.campaign_id
media_partner_groups
action_inquiries.campaign_id = media_partner_groups.campaign_id
action_inquiries.media_partner_id = media_partner_groups.media_partners.partner_id
media_partners
action_inquiries.campaign_id = media_partners.campaigns.campaign_id
action_inquiries.media_partner_id = media_partners.id
notes
action_inquiries.campaign_id = notes.campaign_id
promo_codes
action_inquiries.campaign_id = promo_codes.campaign_id
tracking_value_requests
action_inquiries.campaign_id = tracking_value_requests.campaign_id
action_inquiries.media_partner_id = tracking_value_requests.media_partner_id
unique_urls
action_inquiries.campaign_id = unique_urls.campaign_id
action_inquiries.media_partner_id = unique_urls.media_partner_id

action_id

STRING

action_uri

STRING

auto_approval_date

DATE-TIME

campaign_id

INTEGER

campaign_name

STRING

comments

ARRAY

comment

STRING

date

DATE-TIME

user

STRING

creation_date

DATE-TIME

expected_payout

NUMBER

final_payout

NUMBER

id

INTEGER

inquiry_type

STRING

media_partner_id

INTEGER

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

action_updates

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

update_date

Useful links

action_updates schema on GitHub

Impact API method

Join action_updates with on
actions
action_updates.action_tracker_id = actions.action_tracker_id
action_updates.action_id = actions.id
action_updates.ad_id = actions.ad_id
action_updates.campaign_id = actions.campaign_id
action_updates.customer_id = actions.customer_id
action_updates.media_partner_id = actions.media_partner_id
api_submissions
action_updates.action_tracker_id = api_submissions.action_tracker_id
action_updates.campaign_id = api_submissions.campaign_id
action_updates.media_partner_id = api_submissions.media_partner_id
conversion_paths
action_updates.action_tracker_id = conversion_paths.events.action_tracker_id
action_updates.action_id = conversion_paths.events.action_id
action_updates.ad_id = conversion_paths.events.ad_id
action_updates.campaign_id = conversion_paths.campaign_id
action_updates.customer_id = conversion_paths.customer_id
exception_lists
action_updates.action_tracker_id = exception_lists.action_trackers.id
action_updates.campaign_id = exception_lists.campaign_id
action_inquiries
action_updates.action_id = action_inquiries.action_id
action_updates.campaign_id = action_inquiries.campaign_id
action_updates.media_partner_id = action_inquiries.media_partner_id
ads
action_updates.ad_id = ads.id
action_updates.campaign_id = ads.campaign_id
campaigns
action_updates.campaign_id = campaigns.id
catalogs
action_updates.campaign_id = catalogs.campaign_id
clicks
action_updates.campaign_id = clicks.campaign_id
contacts
action_updates.campaign_id = contacts.campaign_id
deals
action_updates.campaign_id = deals.campaign_id
invoices
action_updates.campaign_id = invoices.line_items.campaign_id
media_partner_groups
action_updates.campaign_id = media_partner_groups.campaign_id
action_updates.media_partner_id = media_partner_groups.media_partners.partner_id
media_partners
action_updates.campaign_id = media_partners.campaigns.campaign_id
action_updates.media_partner_id = media_partners.id
notes
action_updates.campaign_id = notes.campaign_id
promo_codes
action_updates.campaign_id = promo_codes.campaign_id
tracking_value_requests
action_updates.campaign_id = tracking_value_requests.campaign_id
action_updates.media_partner_id = tracking_value_requests.media_partner_id
unique_urls
action_updates.campaign_id = unique_urls.campaign_id
action_updates.media_partner_id = unique_urls.media_partner_id

action_date

DATE-TIME

action_id

STRING

action_tracker_id

INTEGER

action_uri

STRING

ad_id

INTEGER

caller_id

STRING

campaign_id

INTEGER

category

STRING

clearing_date

DATE-TIME

currency

STRING

customer_id

INTEGER

customer_status

STRING

delta_amount

NUMBER

delta_payout

NUMBER

disposition

STRING

id

STRING

locking_date

DATE-TIME

media_partner_id

INTEGER

order_id

STRING

quantity

INTEGER

shared_id

STRING

sku

STRING

state

STRING

state_detail

STRING

state_detail_description

STRING

update_date

DATE-TIME

uri

STRING

actions

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

event_date

Useful links

actions schema on GitHub

Impact API method

Join actions with on
action_updates
actions.action_tracker_id = action_updates.action_tracker_id
actions.id = action_updates.action_id
actions.ad_id = action_updates.ad_id
actions.campaign_id = action_updates.campaign_id
actions.customer_id = action_updates.customer_id
actions.media_partner_id = action_updates.media_partner_id
api_submissions
actions.action_tracker_id = api_submissions.action_tracker_id
actions.campaign_id = api_submissions.campaign_id
actions.media_partner_id = api_submissions.media_partner_id
conversion_paths
actions.action_tracker_id = conversion_paths.events.action_tracker_id
actions.id = conversion_paths.events.action_id
actions.ad_id = conversion_paths.events.ad_id
actions.campaign_id = conversion_paths.campaign_id
actions.customer_id = conversion_paths.customer_id
exception_lists
actions.action_tracker_id = exception_lists.action_trackers.id
actions.campaign_id = exception_lists.campaign_id
action_inquiries
actions.id = action_inquiries.action_id
actions.campaign_id = action_inquiries.campaign_id
actions.media_partner_id = action_inquiries.media_partner_id
ads
actions.ad_id = ads.id
actions.campaign_id = ads.campaign_id
campaigns
actions.campaign_id = campaigns.id
catalogs
actions.campaign_id = catalogs.campaign_id
clicks
actions.campaign_id = clicks.campaign_id
contacts
actions.campaign_id = contacts.campaign_id
deals
actions.campaign_id = deals.campaign_id
invoices
actions.campaign_id = invoices.line_items.campaign_id
media_partner_groups
actions.campaign_id = media_partner_groups.campaign_id
actions.media_partner_id = media_partner_groups.media_partners.partner_id
media_partners
actions.campaign_id = media_partners.campaigns.campaign_id
actions.media_partner_id = media_partners.id
notes
actions.campaign_id = notes.campaign_id
promo_codes
actions.campaign_id = promo_codes.campaign_id
tracking_value_requests
actions.campaign_id = tracking_value_requests.campaign_id
actions.media_partner_id = tracking_value_requests.media_partner_id
unique_urls
actions.campaign_id = unique_urls.campaign_id
actions.media_partner_id = unique_urls.media_partner_id

action_tracker_id

INTEGER

action_tracker_name

STRING

ad_id

INTEGER

amount

NUMBER

caller_id

STRING

campaign_id

INTEGER

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

customer_post_code

STRING

customer_region

STRING

customer_status

STRING

delta_amount

NUMBER

delta_payout

NUMBER

event_date

DATE-TIME

id

STRING

intended_amount

NUMBER

intended_payout

NUMBER

ip_address

STRING

locking_date

DATE-TIME

media_partner_id

INTEGER

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

ads

The ads table contains info about ads.

Replication Method

Full Table

Primary Key

id

Useful links

ads schema on GitHub

Impact API method

Join ads with on
action_updates
ads.id = action_updates.ad_id
ads.campaign_id = action_updates.campaign_id
actions
ads.id = actions.ad_id
ads.campaign_id = actions.campaign_id
conversion_paths
ads.id = conversion_paths.events.ad_id
ads.campaign_id = conversion_paths.campaign_id
action_inquiries
ads.campaign_id = action_inquiries.campaign_id
api_submissions
ads.campaign_id = api_submissions.campaign_id
campaigns
ads.campaign_id = campaigns.id
catalogs
ads.campaign_id = catalogs.campaign_id
clicks
ads.campaign_id = clicks.campaign_id
contacts
ads.campaign_id = contacts.campaign_id
deals
ads.campaign_id = deals.campaign_id
ads.deal_id = deals.id
exception_lists
ads.campaign_id = exception_lists.campaign_id
invoices
ads.campaign_id = invoices.line_items.campaign_id
media_partner_groups
ads.campaign_id = media_partner_groups.campaign_id
media_partners
ads.campaign_id = media_partners.campaigns.campaign_id
notes
ads.campaign_id = notes.campaign_id
promo_codes
ads.campaign_id = promo_codes.campaign_id
ads.deal_id = promo_codes.deal_id
tracking_value_requests
ads.campaign_id = tracking_value_requests.campaign_id
ads.deal_id = tracking_value_requests.deal_id
unique_urls
ads.campaign_id = unique_urls.campaign_id

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

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

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

deal_restricted_media_partner_groups

ARRAY

deal_restricted_media_partners

ARRAY

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

id

INTEGER

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

restricted_media_partners

ARRAY

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

api_submissions

The api_submissions table contains info about API submissions.

Replication Method

Key-based Incremental

Primary Key

batch_id

Replication Key

submission_date

Useful links

api_submissions schema on GitHub

Impact API method

Join api_submissions with on
ftp_file_submissions
api_submissions.account_id = ftp_file_submissions.account_id
action_updates
api_submissions.action_tracker_id = action_updates.action_tracker_id
api_submissions.campaign_id = action_updates.campaign_id
api_submissions.media_partner_id = action_updates.media_partner_id
actions
api_submissions.action_tracker_id = actions.action_tracker_id
api_submissions.campaign_id = actions.campaign_id
api_submissions.media_partner_id = actions.media_partner_id
conversion_paths
api_submissions.action_tracker_id = conversion_paths.events.action_tracker_id
api_submissions.campaign_id = conversion_paths.campaign_id
exception_lists
api_submissions.action_tracker_id = exception_lists.action_trackers.id
api_submissions.campaign_id = exception_lists.campaign_id
action_inquiries
api_submissions.campaign_id = action_inquiries.campaign_id
api_submissions.media_partner_id = action_inquiries.media_partner_id
ads
api_submissions.campaign_id = ads.campaign_id
campaigns
api_submissions.campaign_id = campaigns.id
catalogs
api_submissions.campaign_id = catalogs.campaign_id
clicks
api_submissions.campaign_id = clicks.campaign_id
contacts
api_submissions.campaign_id = contacts.campaign_id
deals
api_submissions.campaign_id = deals.campaign_id
invoices
api_submissions.campaign_id = invoices.line_items.campaign_id
media_partner_groups
api_submissions.campaign_id = media_partner_groups.campaign_id
api_submissions.media_partner_id = media_partner_groups.media_partners.partner_id
media_partners
api_submissions.campaign_id = media_partners.campaigns.campaign_id
api_submissions.media_partner_id = media_partners.id
notes
api_submissions.campaign_id = notes.campaign_id
promo_codes
api_submissions.campaign_id = promo_codes.campaign_id
tracking_value_requests
api_submissions.campaign_id = tracking_value_requests.campaign_id
api_submissions.media_partner_id = tracking_value_requests.media_partner_id
unique_urls
api_submissions.campaign_id = unique_urls.campaign_id
api_submissions.media_partner_id = unique_urls.media_partner_id

account_id

INTEGER

action_tracker_id

INTEGER

batch_id

STRING

campaign_id

INTEGER

completion_date

DATE-TIME

error_reason

STRING

error_type

STRING

event_code

STRING

media_partner_id

INTEGER

order_id

STRING

payload

STRING

status

STRING

submission_date

DATE-TIME

type

STRING

uri

STRING

campaigns

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

Replication Method

Full Table

Primary Key

id

Useful links

campaigns schema on GitHub

Impact API method

Join campaigns with on
action_inquiries
campaigns.id = action_inquiries.campaign_id
action_updates
campaigns.id = action_updates.campaign_id
actions
campaigns.id = actions.campaign_id
ads
campaigns.id = ads.campaign_id
api_submissions
campaigns.id = api_submissions.campaign_id
catalogs
campaigns.id = catalogs.campaign_id
clicks
campaigns.id = clicks.campaign_id
contacts
campaigns.id = contacts.campaign_id
conversion_paths
campaigns.id = conversion_paths.campaign_id
deals
campaigns.id = deals.campaign_id
exception_lists
campaigns.id = exception_lists.campaign_id
invoices
campaigns.id = invoices.line_items.campaign_id
media_partner_groups
campaigns.id = media_partner_groups.campaign_id
media_partners
campaigns.id = media_partners.campaigns.campaign_id
notes
campaigns.id = notes.campaign_id
promo_codes
campaigns.id = promo_codes.campaign_id
tracking_value_requests
campaigns.id = tracking_value_requests.campaign_id
unique_urls
campaigns.id = unique_urls.campaign_id

categories

OBJECT

additional_category

STRING

additional_sub_categories

ARRAY

primary_category

STRING

primary_sub_categories

ARRAY

company_contacts

ARRAY

email_address

STRING

first_name

STRING

last_name

STRING

phone_number

STRING

direct_tracking_settings

OBJECT

session_window_length

INTEGER

unidentified_source_name

STRING

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

gift_card_payouts

BOOLEAN

id

INTEGER

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

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

catalog_items

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

Replication Method

Full Table

Primary Key

catalog_item_id

Useful links

catalog_items schema on GitHub

Impact API method

Join catalog_items with on
catalogs
catalog_items.catalog_id = catalogs.id

additional_image_urls

ARRAY

adult

BOOLEAN

age_group

STRING

asin

STRING

bullets

ARRAY

catalog_id

INTEGER

catalog_item_id

STRING

category

STRING

colors

ARRAY

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

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

catalogs

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

Replication Method

Full Table

Primary Key

id

Useful links

catalogs schema on GitHub

Impact API method

Join catalogs with on
action_inquiries
catalogs.campaign_id = action_inquiries.campaign_id
action_updates
catalogs.campaign_id = action_updates.campaign_id
actions
catalogs.campaign_id = actions.campaign_id
ads
catalogs.campaign_id = ads.campaign_id
api_submissions
catalogs.campaign_id = api_submissions.campaign_id
campaigns
catalogs.campaign_id = campaigns.id
clicks
catalogs.campaign_id = clicks.campaign_id
contacts
catalogs.campaign_id = contacts.campaign_id
conversion_paths
catalogs.campaign_id = conversion_paths.campaign_id
deals
catalogs.campaign_id = deals.campaign_id
exception_lists
catalogs.campaign_id = exception_lists.campaign_id
invoices
catalogs.campaign_id = invoices.line_items.campaign_id
media_partner_groups
catalogs.campaign_id = media_partner_groups.campaign_id
media_partners
catalogs.campaign_id = media_partners.campaigns.campaign_id
notes
catalogs.campaign_id = notes.campaign_id
promo_codes
catalogs.campaign_id = promo_codes.campaign_id
tracking_value_requests
catalogs.campaign_id = tracking_value_requests.campaign_id
unique_urls
catalogs.campaign_id = unique_urls.campaign_id
catalog_items
catalogs.id = catalog_items.catalog_id

advertiser_id

INTEGER

campaign_id

INTEGER

date_last_updated

DATE-TIME

filename

STRING

id

INTEGER

items_uri

STRING

name

STRING

number_of_items

INTEGER

status

STRING

upload_method

STRING

uri

STRING

clicks

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

event_date

Useful links

clicks schema on GitHub

Impact API method

Join clicks with on
action_inquiries
clicks.campaign_id = action_inquiries.campaign_id
action_updates
clicks.campaign_id = action_updates.campaign_id
actions
clicks.campaign_id = actions.campaign_id
ads
clicks.campaign_id = ads.campaign_id
api_submissions
clicks.campaign_id = api_submissions.campaign_id
campaigns
clicks.campaign_id = campaigns.id
catalogs
clicks.campaign_id = catalogs.campaign_id
contacts
clicks.campaign_id = contacts.campaign_id
conversion_paths
clicks.campaign_id = conversion_paths.campaign_id
clicks.media_id = conversion_paths.events.media_id
deals
clicks.campaign_id = deals.campaign_id
exception_lists
clicks.campaign_id = exception_lists.campaign_id
invoices
clicks.campaign_id = invoices.line_items.campaign_id
clicks.media_id = invoices.media_id
media_partner_groups
clicks.campaign_id = media_partner_groups.campaign_id
media_partners
clicks.campaign_id = media_partners.campaigns.campaign_id
notes
clicks.campaign_id = notes.campaign_id
clicks.media_id = notes.media_id
promo_codes
clicks.campaign_id = promo_codes.campaign_id
tracking_value_requests
clicks.campaign_id = tracking_value_requests.campaign_id
unique_urls
clicks.campaign_id = unique_urls.campaign_id

ad_campaign

STRING

ad_group

STRING

ad_id

INTEGER

ad_name

STRING

ad_type

STRING

bid_keyword

STRING

browser

STRING

campaign_id

INTEGER

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

event_date

DATE-TIME

id

STRING

ip_address

STRING

keyword

STRING

landing_page_url

STRING

match_type

STRING

media_id

INTEGER

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

The company_information table contains details about companies.

Replication Method

Full Table

Primary Key

company_name

Useful links

company_information schema on GitHub

Impact API method

billing_address

OBJECT

address_line1

STRING

address_line2

STRING

city

STRING

country

STRING

postal_code

STRING

state

STRING

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_name

STRING

corporate_address

OBJECT

address_line1

STRING

address_line2

STRING

city

STRING

country

STRING

postal_code

STRING

state

STRING

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

indirect_tax_number

STRING

industry

OBJECT

industry_id

INTEGER

industry_name

STRING

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

timezone

STRING

uri

STRING

website

STRING

contacts

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

Replication Method

Full Table

Primary Key

id

Useful links

contacts schema on GitHub

Impact API method

Join contacts with on
action_inquiries
contacts.campaign_id = action_inquiries.campaign_id
action_updates
contacts.campaign_id = action_updates.campaign_id
actions
contacts.campaign_id = actions.campaign_id
ads
contacts.campaign_id = ads.campaign_id
api_submissions
contacts.campaign_id = api_submissions.campaign_id
campaigns
contacts.campaign_id = campaigns.id
catalogs
contacts.campaign_id = catalogs.campaign_id
clicks
contacts.campaign_id = clicks.campaign_id
conversion_paths
contacts.campaign_id = conversion_paths.campaign_id
deals
contacts.campaign_id = deals.campaign_id
exception_lists
contacts.campaign_id = exception_lists.campaign_id
invoices
contacts.campaign_id = invoices.line_items.campaign_id
media_partner_groups
contacts.campaign_id = media_partner_groups.campaign_id
media_partners
contacts.campaign_id = media_partners.campaigns.campaign_id
notes
contacts.campaign_id = notes.campaign_id
promo_codes
contacts.campaign_id = promo_codes.campaign_id
tracking_value_requests
contacts.campaign_id = tracking_value_requests.campaign_id
unique_urls
contacts.campaign_id = unique_urls.campaign_id

accounts

ARRAY

id

INTEGER

name

STRING

OBJECT

campaign_id

INTEGER

cellphone_number

STRING

cellphone_number_country

STRING

email_address

STRING

first_name

STRING

id

STRING

labels

ARRAY

last_name

STRING

profile_image

STRING

title

STRING

uri

STRING

work_phone_number

INTEGER

work_phone_number_country

STRING

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.

Replication Method

Full Table

Primary Keys

campaign_id

customer_id

model_id

Useful links

conversion_paths schema on GitHub

Impact API method

Join conversion_paths with on
action_updates
conversion_paths.events.action_tracker_id = action_updates.action_tracker_id
conversion_paths.events.action_id = action_updates.action_id
conversion_paths.events.ad_id = action_updates.ad_id
conversion_paths.campaign_id = action_updates.campaign_id
conversion_paths.customer_id = action_updates.customer_id
actions
conversion_paths.events.action_tracker_id = actions.action_tracker_id
conversion_paths.events.action_id = actions.id
conversion_paths.events.ad_id = actions.ad_id
conversion_paths.campaign_id = actions.campaign_id
conversion_paths.customer_id = actions.customer_id
api_submissions
conversion_paths.events.action_tracker_id = api_submissions.action_tracker_id
conversion_paths.campaign_id = api_submissions.campaign_id
exception_lists
conversion_paths.events.action_tracker_id = exception_lists.action_trackers.id
conversion_paths.campaign_id = exception_lists.campaign_id
action_inquiries
conversion_paths.events.action_id = action_inquiries.action_id
conversion_paths.campaign_id = action_inquiries.campaign_id
ads
conversion_paths.events.ad_id = ads.id
conversion_paths.campaign_id = ads.campaign_id
campaigns
conversion_paths.campaign_id = campaigns.id
catalogs
conversion_paths.campaign_id = catalogs.campaign_id
clicks
conversion_paths.campaign_id = clicks.campaign_id
conversion_paths.events.media_id = clicks.media_id
contacts
conversion_paths.campaign_id = contacts.campaign_id
deals
conversion_paths.campaign_id = deals.campaign_id
invoices
conversion_paths.campaign_id = invoices.line_items.campaign_id
conversion_paths.events.media_id = invoices.media_id
media_partner_groups
conversion_paths.campaign_id = media_partner_groups.campaign_id
media_partners
conversion_paths.campaign_id = media_partners.campaigns.campaign_id
notes
conversion_paths.campaign_id = notes.campaign_id
conversion_paths.events.media_id = notes.media_id
promo_codes
conversion_paths.campaign_id = promo_codes.campaign_id
tracking_value_requests
conversion_paths.campaign_id = tracking_value_requests.campaign_id
unique_urls
conversion_paths.campaign_id = unique_urls.campaign_id

campaign_id

INTEGER

campaign_name

STRING

channel_count

INTEGER

cost

NUMBER

customer_id

INTEGER

events

ARRAY

action_date

DATE-TIME

action_id

STRING

action_tracker_id

INTEGER

action_tracker_name

STRING

ad_campaign

STRING

ad_distribution_type

STRING

ad_group

STRING

ad_id

INTEGER

ad_name

STRING

ad_site_location

STRING

amount

NUMBER

app_name

STRING

app_package_name

STRING

app_version

STRING

attributed_credit

NUMBER

attributed_revenue

NUMBER

browser

STRING

channel

STRING

customer_area

STRING

customer_city

STRING

customer_country

STRING

customer_post_code

STRING

customer_region

STRING

customer_status

STRING

date_1

DATE

date_2

DATE

date_3

DATE

deal_name

STRING

deal_scope

STRING

deal_type

STRING

device_family

STRING

device_type

STRING

event_date

DATE-TIME

fingerprint

STRING

id

STRING

keyword

STRING

landing_page

STRING

match_type

STRING

media_id

INTEGER

media_name

STRING

money_1

NUMBER

money_2

NUMBER

money_3

NUMBER

note

STRING

numeric_1

NUMBER

numeric_2

NUMBER

numeric_3

NUMBER

order_discount

NUMBER

order_id

STRING

order_margin

NUMBER

order_shipping

NUMBER

order_subtotal

NUMBER

order_tax

NUMBER

order_vat

NUMBER

os

STRING

payout

NUMBER

phone_number

STRING

platform

STRING

position_type

STRING

profile_id

STRING

promocode

STRING

referring_url

STRING

shared_id

STRING

site_category

STRING

site_version

STRING

step

INTEGER

sub_id_1

INTEGER

sub_id_2

INTEGER

sub_id_3

INTEGER

sub_type

STRING

text_1

STRING

text_2

STRING

text_3

STRING

traffic_type

STRING

type

STRING

latency

NUMBER

media_count

INTEGER

model_id

INTEGER

model_name

STRING

referral_counts

ARRAY

count

INTEGER

type

STRING

revenue

NUMBER

steps

INTEGER

uri

STRING

deals

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

Replication Method

Full Table

Primary Key

id

Useful links

deals schema on GitHub

Impact API method

Join deals with on
action_inquiries
deals.campaign_id = action_inquiries.campaign_id
action_updates
deals.campaign_id = action_updates.campaign_id
actions
deals.campaign_id = actions.campaign_id
ads
deals.campaign_id = ads.campaign_id
deals.id = ads.deal_id
api_submissions
deals.campaign_id = api_submissions.campaign_id
campaigns
deals.campaign_id = campaigns.id
catalogs
deals.campaign_id = catalogs.campaign_id
clicks
deals.campaign_id = clicks.campaign_id
contacts
deals.campaign_id = contacts.campaign_id
conversion_paths
deals.campaign_id = conversion_paths.campaign_id
exception_lists
deals.campaign_id = exception_lists.campaign_id
invoices
deals.campaign_id = invoices.line_items.campaign_id
media_partner_groups
deals.campaign_id = media_partner_groups.campaign_id
media_partners
deals.campaign_id = media_partners.campaigns.campaign_id
notes
deals.campaign_id = notes.campaign_id
promo_codes
deals.campaign_id = promo_codes.campaign_id
deals.id = promo_codes.deal_id
tracking_value_requests
deals.campaign_id = tracking_value_requests.campaign_id
deals.id = tracking_value_requests.deal_id
unique_urls
deals.campaign_id = unique_urls.campaign_id

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

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

id

INTEGER

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

STRING

product_before_price_amount

NUMBER

product_before_price_currency

STRING

product_image_url

STRING

product_name

STRING

purchase_limit_quantity

STRING

rebate_amount

NUMBER

rebate_currency

STRING

restricted_media_partner_groups

ARRAY

restricted_media_partners

ARRAY

scope

STRING

start_date

DATE-TIME

state

STRING

synch_ads_promo_codes

STRING

type

STRING

uri

STRING

exception_list_items

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

Replication Method

Full Table

Primary Key

id

Useful links

exception_list_items schema on GitHub

Impact API method

Join exception_list_items with on
exception_lists
exception_list_items.list_id = exception_lists.id

created_date

DATE-TIME

id

INTEGER

list_id

INTEGER

match_mode

STRING

name

STRING

uri

STRING

value

STRING

exception_lists

The exception_lists table contains info about exception lists.

Replication Method

Full Table

Primary Key

id

Useful links

exception_lists schema on GitHub

Impact API method

Join exception_lists with on
action_updates
exception_lists.action_trackers.id = action_updates.action_tracker_id
exception_lists.campaign_id = action_updates.campaign_id
actions
exception_lists.action_trackers.id = actions.action_tracker_id
exception_lists.campaign_id = actions.campaign_id
api_submissions
exception_lists.action_trackers.id = api_submissions.action_tracker_id
exception_lists.campaign_id = api_submissions.campaign_id
conversion_paths
exception_lists.action_trackers.id = conversion_paths.events.action_tracker_id
exception_lists.campaign_id = conversion_paths.campaign_id
action_inquiries
exception_lists.campaign_id = action_inquiries.campaign_id
ads
exception_lists.campaign_id = ads.campaign_id
campaigns
exception_lists.campaign_id = campaigns.id
catalogs
exception_lists.campaign_id = catalogs.campaign_id
clicks
exception_lists.campaign_id = clicks.campaign_id
contacts
exception_lists.campaign_id = contacts.campaign_id
deals
exception_lists.campaign_id = deals.campaign_id
invoices
exception_lists.campaign_id = invoices.line_items.campaign_id
media_partner_groups
exception_lists.campaign_id = media_partner_groups.campaign_id
media_partners
exception_lists.campaign_id = media_partners.campaigns.campaign_id
notes
exception_lists.campaign_id = notes.campaign_id
promo_codes
exception_lists.campaign_id = promo_codes.campaign_id
tracking_value_requests
exception_lists.campaign_id = tracking_value_requests.campaign_id
unique_urls
exception_lists.campaign_id = unique_urls.campaign_id
exception_list_items
exception_lists.id = exception_list_items.list_id

action_trackers

ARRAY

id

INTEGER

name

STRING

campaign_id

INTEGER

created_date

DATE-TIME

deactivation_date

DATE-TIME

id

INTEGER

items_uri

STRING

name

STRING

number_of_items

INTEGER

state

STRING

type

STRING

uri

STRING

ftp_file_submissions

The ftp_file_submissions table contains info about FTP file submissions.

Replication Method

Key-based Incremental

Primary Key

batch_id

Replication Key

submission_date

Useful links

ftp_file_submissions schema on GitHub

Impact API method

Join ftp_file_submissions with on
api_submissions
ftp_file_submissions.account_id = api_submissions.account_id

account_id

INTEGER

batch_id

STRING

completion_date

DATE-TIME

errors_uri

STRING

file_name

STRING

status

STRING

submission_date

DATE-TIME

total_errors

STRING

total_records

INTEGER

type

STRING

uri

STRING

invoices

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

created_date

Useful links

invoices schema on GitHub

Impact API method

Join invoices with on
action_inquiries
invoices.line_items.campaign_id = action_inquiries.campaign_id
action_updates
invoices.line_items.campaign_id = action_updates.campaign_id
actions
invoices.line_items.campaign_id = actions.campaign_id
ads
invoices.line_items.campaign_id = ads.campaign_id
api_submissions
invoices.line_items.campaign_id = api_submissions.campaign_id
campaigns
invoices.line_items.campaign_id = campaigns.id
catalogs
invoices.line_items.campaign_id = catalogs.campaign_id
clicks
invoices.line_items.campaign_id = clicks.campaign_id
invoices.media_id = clicks.media_id
contacts
invoices.line_items.campaign_id = contacts.campaign_id
conversion_paths
invoices.line_items.campaign_id = conversion_paths.campaign_id
invoices.media_id = conversion_paths.events.media_id
deals
invoices.line_items.campaign_id = deals.campaign_id
exception_lists
invoices.line_items.campaign_id = exception_lists.campaign_id
media_partner_groups
invoices.line_items.campaign_id = media_partner_groups.campaign_id
media_partners
invoices.line_items.campaign_id = media_partners.campaigns.campaign_id
notes
invoices.line_items.campaign_id = notes.campaign_id
invoices.media_id = notes.media_id
promo_codes
invoices.line_items.campaign_id = promo_codes.campaign_id
tracking_value_requests
invoices.line_items.campaign_id = tracking_value_requests.campaign_id
unique_urls
invoices.line_items.campaign_id = unique_urls.campaign_id

created_date

DATE-TIME

currency

STRING

id

STRING

line_items

ARRAY

actions

INTEGER

campaign_id

INTEGER

campaign_name

STRING

description

STRING

due_date

DATE-TIME

event_month_year

STRING

net_item_amount

NUMBER

paid_date

DATE-TIME

status

STRING

total_item_amount

NUMBER

vat_item_amount

NUMBER

media_id

INTEGER

media_name

STRING

pdf

STRING

total_amount

NUMBER

total_vat_amount

NUMBER

media_partner_groups

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

Replication Method

Full Table

Primary Key

id

Useful links

media_partner_groups schema on GitHub

Impact API method

Join media_partner_groups with on
action_inquiries
media_partner_groups.campaign_id = action_inquiries.campaign_id
media_partner_groups.media_partners.partner_id = action_inquiries.media_partner_id
action_updates
media_partner_groups.campaign_id = action_updates.campaign_id
media_partner_groups.media_partners.partner_id = action_updates.media_partner_id
actions
media_partner_groups.campaign_id = actions.campaign_id
media_partner_groups.media_partners.partner_id = actions.media_partner_id
ads
media_partner_groups.campaign_id = ads.campaign_id
api_submissions
media_partner_groups.campaign_id = api_submissions.campaign_id
media_partner_groups.media_partners.partner_id = api_submissions.media_partner_id
campaigns
media_partner_groups.campaign_id = campaigns.id
catalogs
media_partner_groups.campaign_id = catalogs.campaign_id
clicks
media_partner_groups.campaign_id = clicks.campaign_id
contacts
media_partner_groups.campaign_id = contacts.campaign_id
conversion_paths
media_partner_groups.campaign_id = conversion_paths.campaign_id
deals
media_partner_groups.campaign_id = deals.campaign_id
exception_lists
media_partner_groups.campaign_id = exception_lists.campaign_id
invoices
media_partner_groups.campaign_id = invoices.line_items.campaign_id
media_partners
media_partner_groups.campaign_id = media_partners.campaigns.campaign_id
media_partner_groups.id = media_partners.groups.group_id
media_partner_groups.media_partners.partner_id = media_partners.id
notes
media_partner_groups.campaign_id = notes.campaign_id
promo_codes
media_partner_groups.campaign_id = promo_codes.campaign_id
tracking_value_requests
media_partner_groups.campaign_id = tracking_value_requests.campaign_id
media_partner_groups.media_partners.partner_id = tracking_value_requests.media_partner_id
unique_urls
media_partner_groups.campaign_id = unique_urls.campaign_id
media_partner_groups.media_partners.partner_id = unique_urls.media_partner_id

campaign_id

INTEGER

id

INTEGER

media_partners

ARRAY

partner_id

INTEGER

partner_name

STRING

partner_uri

STRING

name

STRING

uri

STRING

media_partners

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

Replication Method

Full Table

Primary Key

id

Useful links

media_partners schema on GitHub

Impact API method

Join media_partners with on
action_inquiries
media_partners.campaigns.campaign_id = action_inquiries.campaign_id
media_partners.id = action_inquiries.media_partner_id
action_updates
media_partners.campaigns.campaign_id = action_updates.campaign_id
media_partners.id = action_updates.media_partner_id
actions
media_partners.campaigns.campaign_id = actions.campaign_id
media_partners.id = actions.media_partner_id
ads
media_partners.campaigns.campaign_id = ads.campaign_id
api_submissions
media_partners.campaigns.campaign_id = api_submissions.campaign_id
media_partners.id = api_submissions.media_partner_id
campaigns
media_partners.campaigns.campaign_id = campaigns.id
catalogs
media_partners.campaigns.campaign_id = catalogs.campaign_id
clicks
media_partners.campaigns.campaign_id = clicks.campaign_id
contacts
media_partners.campaigns.campaign_id = contacts.campaign_id
conversion_paths
media_partners.campaigns.campaign_id = conversion_paths.campaign_id
deals
media_partners.campaigns.campaign_id = deals.campaign_id
exception_lists
media_partners.campaigns.campaign_id = exception_lists.campaign_id
invoices
media_partners.campaigns.campaign_id = invoices.line_items.campaign_id
media_partner_groups
media_partners.campaigns.campaign_id = media_partner_groups.campaign_id
media_partners.groups.group_id = media_partner_groups.id
media_partners.id = media_partner_groups.media_partners.partner_id
notes
media_partners.campaigns.campaign_id = notes.campaign_id
promo_codes
media_partners.campaigns.campaign_id = promo_codes.campaign_id
tracking_value_requests
media_partners.campaigns.campaign_id = tracking_value_requests.campaign_id
media_partners.id = tracking_value_requests.media_partner_id
unique_urls
media_partners.campaigns.campaign_id = unique_urls.campaign_id
media_partners.id = unique_urls.media_partner_id

address_line1

STRING

address_line2

STRING

campaigns

ARRAY

campaign_id

INTEGER

campaign_name

STRING

insertion_order_id

INTEGER

insertion_order_name

STRING

join_date

DATE-TIME

city

STRING

contact

OBJECT

email_address

STRING

first_name

STRING

last_name

STRING

phone_number

STRING

country

STRING

country_state

STRING

currency

STRING

date_created

DATE-TIME

description

STRING

groups

ARRAY

group_id

INTEGER

group_name

STRING

id

INTEGER

mp_value1

STRING

mp_value2

STRING

mp_value3

STRING

name

STRING

partner_type

STRING

phone_number

STRING

postal_code

STRING

primary_promotional_method

STRING

promoting_countries

STRING

promotional_methods

STRING

rating

INTEGER

relationship_state

STRING

state

STRING

timezone

STRING

uri

STRING

website

STRING

notes

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

modification_date

Useful links

notes schema on GitHub

Impact API method

Join notes with on
action_inquiries
notes.campaign_id = action_inquiries.campaign_id
action_updates
notes.campaign_id = action_updates.campaign_id
actions
notes.campaign_id = actions.campaign_id
ads
notes.campaign_id = ads.campaign_id
api_submissions
notes.campaign_id = api_submissions.campaign_id
campaigns
notes.campaign_id = campaigns.id
catalogs
notes.campaign_id = catalogs.campaign_id
clicks
notes.campaign_id = clicks.campaign_id
notes.media_id = clicks.media_id
contacts
notes.campaign_id = contacts.campaign_id
conversion_paths
notes.campaign_id = conversion_paths.campaign_id
notes.media_id = conversion_paths.events.media_id
deals
notes.campaign_id = deals.campaign_id
exception_lists
notes.campaign_id = exception_lists.campaign_id
invoices
notes.campaign_id = invoices.line_items.campaign_id
notes.media_id = invoices.media_id
media_partner_groups
notes.campaign_id = media_partner_groups.campaign_id
media_partners
notes.campaign_id = media_partners.campaigns.campaign_id
promo_codes
notes.campaign_id = promo_codes.campaign_id
tracking_value_requests
notes.campaign_id = tracking_value_requests.campaign_id
unique_urls
notes.campaign_id = unique_urls.campaign_id

attachments

ARRAY

campaign_id

INTEGER

content

STRING

creation_date

STRING

creator

STRING

id

INTEGER

media_id

INTEGER

media_name

STRING

modification_date

DATE-TIME

type

STRING

uri

STRING

phone_numbers

The phone_numbers table contains info about phone numbers.

Replication Method

Full Table

Primary Key

id

Useful links

phone_numbers schema on GitHub

Impact API method

Join phone_numbers with on
tracking_value_requests
phone_numbers.id = tracking_value_requests.phone_numbers.id

country

STRING

date_created

DATE-TIME

id

INTEGER

international_number

STRING

last_date_assigned

DATE-TIME

last_date_released

DATE-TIME

number

STRING

uri

STRING

promo_codes

The promo_codes table contains info about promo codes.

Replication Method

Full Table

Primary Key

id

Useful links

promo_codes schema on GitHub

Impact API method

Join promo_codes with on
action_inquiries
promo_codes.campaign_id = action_inquiries.campaign_id
action_updates
promo_codes.campaign_id = action_updates.campaign_id
actions
promo_codes.campaign_id = actions.campaign_id
ads
promo_codes.campaign_id = ads.campaign_id
promo_codes.deal_id = ads.deal_id
api_submissions
promo_codes.campaign_id = api_submissions.campaign_id
campaigns
promo_codes.campaign_id = campaigns.id
catalogs
promo_codes.campaign_id = catalogs.campaign_id
clicks
promo_codes.campaign_id = clicks.campaign_id
contacts
promo_codes.campaign_id = contacts.campaign_id
conversion_paths
promo_codes.campaign_id = conversion_paths.campaign_id
deals
promo_codes.campaign_id = deals.campaign_id
promo_codes.deal_id = deals.id
exception_lists
promo_codes.campaign_id = exception_lists.campaign_id
invoices
promo_codes.campaign_id = invoices.line_items.campaign_id
media_partner_groups
promo_codes.campaign_id = media_partner_groups.campaign_id
media_partners
promo_codes.campaign_id = media_partners.campaigns.campaign_id
notes
promo_codes.campaign_id = notes.campaign_id
tracking_value_requests
promo_codes.campaign_id = tracking_value_requests.campaign_id
promo_codes.deal_id = tracking_value_requests.deal_id
promo_codes.id = tracking_value_requests.promo_codes.id
unique_urls
promo_codes.campaign_id = unique_urls.campaign_id

assigned_partner_id

INTEGER

assigned_partner_name

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

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

campaign_name

STRING

code

STRING

created_date

DATE-TIME

credit_policy

STRING

deal_categories

STRING

deal_default_promo_code

STRING

deal_description

STRING

deal_end_date

DATE-TIME

deal_id

STRING

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

deal_restricted_media_partner_groups

ARRAY

deal_restricted_media_partners

ARRAY

deal_scope

STRING

deal_start_date

DATE-TIME

deal_state

STRING

deal_type

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

id

INTEGER

maximum_savings_amount

NUMBER

maximum_savings_currency

STRING

minimum_purchase_amount

NUMBER

minimum_purchase_amount_currency

STRING

purchase_limit_quantity

STRING

rebate_amount

NUMBER

rebate_currency

STRING

start_date

DATE-TIME

state

STRING

synch_ads_promo_codes

STRING

type

STRING

uri

STRING

report_metadata

The report_metadata table contains info about metadata associated with reports.

Replication Method

Full Table

Primary Key

id

Useful links

report_metadata schema on GitHub

Impact API method

Join report_metadata with on
reports
report_metadata.id = reports.id

attributes

ARRAY

data_type

STRING

description

STRING

name

STRING

description

STRING

filters

ARRAY

data_type

STRING

format

STRING

name

STRING

id

STRING

name

STRING

run_uri

STRING

uri

STRING

reports

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

Replication Method

Full Table

Primary Key

id

Useful links

reports schema on GitHub

Impact API method

Join reports with on
report_metadata
reports.id = report_metadata.id

description

STRING

id

STRING

meta_data_uri

STRING

name

STRING

run_uri

STRING

tracking_value_requests

The tracking_value_requests table contains info about tracking value requests.

Replication Method

Full Table

Primary Key

id

Useful links

tracking_value_requests schema on GitHub

Impact API method

Join tracking_value_requests with on
action_inquiries
tracking_value_requests.campaign_id = action_inquiries.campaign_id
tracking_value_requests.media_partner_id = action_inquiries.media_partner_id
action_updates
tracking_value_requests.campaign_id = action_updates.campaign_id
tracking_value_requests.media_partner_id = action_updates.media_partner_id
actions
tracking_value_requests.campaign_id = actions.campaign_id
tracking_value_requests.media_partner_id = actions.media_partner_id
ads
tracking_value_requests.campaign_id = ads.campaign_id
tracking_value_requests.deal_id = ads.deal_id
api_submissions
tracking_value_requests.campaign_id = api_submissions.campaign_id
tracking_value_requests.media_partner_id = api_submissions.media_partner_id
campaigns
tracking_value_requests.campaign_id = campaigns.id
catalogs
tracking_value_requests.campaign_id = catalogs.campaign_id
clicks
tracking_value_requests.campaign_id = clicks.campaign_id
contacts
tracking_value_requests.campaign_id = contacts.campaign_id
conversion_paths
tracking_value_requests.campaign_id = conversion_paths.campaign_id
deals
tracking_value_requests.campaign_id = deals.campaign_id
tracking_value_requests.deal_id = deals.id
exception_lists
tracking_value_requests.campaign_id = exception_lists.campaign_id
invoices
tracking_value_requests.campaign_id = invoices.line_items.campaign_id
media_partner_groups
tracking_value_requests.campaign_id = media_partner_groups.campaign_id
tracking_value_requests.media_partner_id = media_partner_groups.media_partners.partner_id
media_partners
tracking_value_requests.campaign_id = media_partners.campaigns.campaign_id
tracking_value_requests.media_partner_id = media_partners.id
notes
tracking_value_requests.campaign_id = notes.campaign_id
promo_codes
tracking_value_requests.campaign_id = promo_codes.campaign_id
tracking_value_requests.deal_id = promo_codes.deal_id
tracking_value_requests.promo_codes.id = promo_codes.id
unique_urls
tracking_value_requests.campaign_id = unique_urls.campaign_id
tracking_value_requests.media_partner_id = unique_urls.media_partner_id
tracking_value_requests.unique_urls.id = unique_urls.id
phone_numbers
tracking_value_requests.phone_numbers.id = phone_numbers.id

additional_instructions

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

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

campaign_name

STRING

date_completed

DATE-TIME

date_needed

DATE-TIME

date_placed

DATE-TIME

deal_categories

STRING

deal_default_promo_code

STRING

deal_description

STRING

deal_end_date

DATE-TIME

deal_id

STRING

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

deal_restricted_media_partner_groups

ARRAY

deal_restricted_media_partners

ARRAY

deal_scope

STRING

deal_start_date

DATE-TIME

deal_state

STRING

deal_type

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

gift

STRING

id

INTEGER

maximum_savings_amount

NUMBER

maximum_savings_currency

STRING

media_partner_id

INTEGER

media_partner_name

STRING

minimum_purchase_amount

NUMBER

minimum_purchase_amount_currency

STRING

number_requested

INTEGER

phone_numbers

ARRAY

assigned_phone_number

STRING

assigned_phone_number_id

INTEGER

id

INTEGER

processing_comments

STRING

promo_codes

ARRAY

approved_code

STRING

credit_policy

STRING

id

INTEGER

match_mode

STRING

requested_code

STRING

purchase_limit_quantity

STRING

rebate_amount

NUMBER

rebate_currency

STRING

request_type

STRING

state

STRING

synch_ads_promo_codes

STRING

unique_urls

ARRAY

id

INTEGER

url

STRING

url_id

INTEGER

uri

STRING

unique_urls

The unique_urls table contains info about unique URLs.

Replication Method

Full Table

Primary Key

id

Useful links

unique_urls schema on GitHub

Impact API method

Join unique_urls with on
action_inquiries
unique_urls.campaign_id = action_inquiries.campaign_id
unique_urls.media_partner_id = action_inquiries.media_partner_id
action_updates
unique_urls.campaign_id = action_updates.campaign_id
unique_urls.media_partner_id = action_updates.media_partner_id
actions
unique_urls.campaign_id = actions.campaign_id
unique_urls.media_partner_id = actions.media_partner_id
ads
unique_urls.campaign_id = ads.campaign_id
api_submissions
unique_urls.campaign_id = api_submissions.campaign_id
unique_urls.media_partner_id = api_submissions.media_partner_id
campaigns
unique_urls.campaign_id = campaigns.id
catalogs
unique_urls.campaign_id = catalogs.campaign_id
clicks
unique_urls.campaign_id = clicks.campaign_id
contacts
unique_urls.campaign_id = contacts.campaign_id
conversion_paths
unique_urls.campaign_id = conversion_paths.campaign_id
deals
unique_urls.campaign_id = deals.campaign_id
exception_lists
unique_urls.campaign_id = exception_lists.campaign_id
invoices
unique_urls.campaign_id = invoices.line_items.campaign_id
media_partner_groups
unique_urls.campaign_id = media_partner_groups.campaign_id
unique_urls.media_partner_id = media_partner_groups.media_partners.partner_id
media_partners
unique_urls.campaign_id = media_partners.campaigns.campaign_id
unique_urls.media_partner_id = media_partners.id
notes
unique_urls.campaign_id = notes.campaign_id
promo_codes
unique_urls.campaign_id = promo_codes.campaign_id
tracking_value_requests
unique_urls.campaign_id = tracking_value_requests.campaign_id
unique_urls.media_partner_id = tracking_value_requests.media_partner_id
unique_urls.id = tracking_value_requests.unique_urls.id

campaign_id

INTEGER

campaign_name

STRING

date_created

DATE-TIME

date_last_assigned

DATE-TIME

date_last_released

DATE-TIME

id

INTEGER

landing_page

STRING

media_partner_id

INTEGER

media_partner_name

STRING

state

STRING

uri

STRING

url

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.