Pepperjam Integration Extractor Info

INTEGRATION OVERVIEW

 

Pepperjam is an affiliate marketing platform used by merchants to manage their web-based affiliate advertising campaigns. Pepperjam collects data from publishers (affiliates) and reports metrics such as clicks, impressions, revenue, spend, etc. The Daasity integration with Pepperjam extracts data from the most important endpoints needed to populate the UMS tables: Transaction History, Creative Performance by Publisher, and Publisher Performance.

This integration is available for:

  • Growth
  • Pro V1
  • Pro V2

 

ERD EMBED

 

ENDPOINT: Pepperjam

All Pepperjam endpoints are accessed through a single url: https://api.pepperjamnetwork.com

The following endpoints are used in data extraction:

 

Publisher Performance TABLE

API Endpoint: /20120402/advertiser/report/transaction-summary 

Data Mapping

JSON Element  Database Column Datatype
publisher_Id publisher_id VARCHAR(255)
date transaction_date TIMESTAMP
impressions impressions BIGINT
clicks clicks BIGINT
sales sales BIGINT
leads leads BIGINT
sale_lead_amount sales_lead_amount DECIMAL(20,4)
earnings_per_click earnings_per_click DECIMAL(20,4)
bonus_amount bonus_amount DECIMAL(20,4)
total_commission total_commission DECIMAL(20,4)
site_bonus site_bonus DECIMAL(20,4)
site_commission site_commission DECIMAL(20,4)
publisher_bonus publisher_bonus DECIMAL(20,4)
publisher_commission publisher_commission DECIMAL(20,4)
publisher publisher VARCHAR(255)
company company VARCHAR(255)
state state VARCHAR(255)
website website VARCHAR(255)
publisher_type publisher_type VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(publisher_id, date, source_id)

Transaction History TABLE

API Endpoint: /20120402/advertiser/report/transaction-history 

Data Mapping

JSON Element  Database Column Datatype
publisher_Id publisher_id VARCHAR(255)
transaction_id transaction_id VARCHAR(255)
sale_date sale_date TIMESTAMP
order_id order_id VARCHAR(255)
status status VARCHAR(255)
link_type link_type VARCHAR(255)
transaction_type transaction_type VARCHAR(255)
publisher_commission publisher_commission DECIMAL(20,4)
site_commission site_commission DECIMAL(20,4)
sale_amount sale_amount DECIMAL(20,4)
process_date process_date TIMESTAMP
revision revision VARCHAR(255)
item_id item_id VARCHAR(255)
publisher publisher VARCHAR(255)
company company VARCHAR(255)
website_url website_url VARCHAR(255)
publisher_type publisher_type VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(transaction_id, item_id, revision, sale_date, _source_id)

Creative Performance by Publisher TABLE

API Endpoint: /20120402/advertiser/report/createive-details-publisher 

Data Mapping

JSON Element  Database Column Datatype
creative_id creative_id VARCHAR(255)
creative_type creative_type VARCHAR(255)
creative_name creative_name VARCHAR(255)
publisher_id publisher_id VARCHAR(255)
publisher publisher VARCHAR(255)
date date TIMESTAMP
impressions impressions BIGINT
transactions transactions BIGINT
clicks clicks BIGINT
click_though_rate clikc_through_rate DECIMAL(20,4)
sales sales DECIMAL(20,4)
earnings_per_click earnings_per_click DECIMAL(20,4)
commission commission DECIMAL(20,4)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(publisher_id, creative_id, addate, _source_id)

Creative Type Text TABLE

API Endpoint: /20120402/advertiser/creative/text 

Data Mapping

JSON Element  Database Column Datatype
id id VARCHAR(255)
type type VARCHAR(255)
url url VARCHAR(255)
description description VARCHAR(255)
allow_deep_link allow_deep_link BOOLEAN
start_date start_date TIMESTAMP
end_date end_date TIMESTAMP
view_date view_date TIMESTAMP
created created_at TIMESTAMP
modified updated_at TIMESTAMP
status status VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(id, type, _source_id)

Creative Type Banner TABLE

API Endpoint: /20120402/advertiser/creative/banner 

Data Mapping

JSON Element  Database Column Datatype
id id VARCHAR(255)
type type VARCHAR(255)
name name VARCHAR(255)
destination_url destination_url VARCHAR(255)
banner_url banner_url VARCHAR(255)
width width BIGINT
height height BIGINT
description description VARCHAR(255)
allow_deep_link allow_deep_link BOOLEAN
start_date start_date TIMESTAMP
end_date end_date TIMESTAMP
view_date view_date TIMESTAMP
created created_at TIMESTAMP
modified updated_at TIMESTAMP
status status VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(id, type, _source_id)

Creative Type Advanced TABLE

API Endpoint: /20120402/advertiser/creative/advanced

Data Mapping

JSON Element  Database Column Datatype
id id VARCHAR(255)
type type VARCHAR(255)
name name VARCHAR(255)
sub_type sub_type VARCHAR(255)
code code VARCHAR(MAX)
description description VARCHAR(255)
verified verified BOOLEAN
start_date start_date TIMESTAMP
end_date end_date TIMESTAMP
view_date view_date TIMESTAMP
created created_at TIMESTAMP
modified updated_at TIMESTAMP
status status VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(id, type, _source_id)

Creative Type Coupon TABLE

API Endpoint: /20120402/advertiser/creative/coupon

Data Mapping

JSON Element  Database Column Datatype
id id VARCHAR(255)
type type VARCHAR(255)
name name VARCHAR(255)
description description VARCHAR(255)
url url VARCHAR(MAX)
coupon_code coupon_code VARCHAR(255)
personalized personalized BOOLEAN
start_date start_date TIMESTAMP
end_date end_date TIMESTAMP
view_date view_date TIMESTAMP
created created_at TIMESTAMP
modified updated_at TIMESTAMP
status status VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(id, type, _source_id)

Creative Promotions TABLE

API Endpoint: /20120402/advertiser/creative/{type}

Data Mapping

JSON Element  Database Column Datatype
id creative_id VARCHAR(255)
type creative_type VARCHAR(255)
promotions.id promotion_id VARCHAR(255)
promotions.name promotion_name VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(id, type, promotion_id, _source_id)

Creative Private Affiliates TABLE

API Endpoint: /20120402/advertiser/creative/{type}

Data Mapping

JSON Element  Database Column Datatype
id creative_id VARCHAR(255)
type creative_type VARCHAR(255)
private_affiliates_id private_affiliate_id VARCHAR(255)
private_affiliates_first_name private_affiliate_firstname VARCHAR(255)
private_affiliates_last_name private_affiliate_lastname VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(id, type, affiliate_id, _source_id)

Creative Type Generic TABLE

API Endpoint: /20120402/advertiser/creative/generic

Data Mapping

JSON Element  Database Column Datatype
type type VARCHAR(255)
allow_deep_link allow_deep_link BOOLEAN
url url VARCHAR(255)
modified updated_at TIMESTAMP
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(type, url, __source_id)

Creative Type Promotion TABLE

API Endpoint: /20120402/advertiser/creative/generic

Data Mapping

JSON Element  Database Column Datatype
id id VARCHAR(255)
name name VARCHAR(255)
Daasity: {unique id} _account_id CHAR(36)
Daasity: {merchant name} __source_id VARCHAR(255)
Daasity: id generated for each unique record __sync_key CHAR(32)
Daasity: timestamp when loaded into DB __synced_at TIMESTAMP

Business Rules

Business Rule Value
Load Type UPSERT
Extraction Frequency DAILY
Sync Key MD5(id, name, __source_id)

EXTRACTION EXAMPLE

Postman can be used to query the Pepperjam API and check the data returned from each endpoint

 

Was this article helpful?
0 out of 0 found this helpful