TradeTracker Merchant API Reference

The public API procedures use the internal procedures, that should not be used directly as they can be changed without an explicit notification in the newer versions of the connector. Internal procedures can be recognized by the internal_ prefix in their name. Public API procedures do not have such prefixes in their names.

AffiliateSiteCategories

Affiliate site categories
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
ID	long
name	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_AffiliateSiteCategories AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.AffiliateSiteCategories ()
	) AS x

AffiliateSitePerformance

Campaign performance statistics per affiliate site
Parameter
<affiliateSiteID> (optional): Affiliate site id
<campaignID> (optional): Campaign id
<dateFrom> (optional): Date from
<dateTo> (optional): Date to
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
affiliateSite_ID	long
affiliateSite_URL	string
affiliateSite_info	string
affiliateSite_name	string
reportData_CLR	bigdecimal
reportData_CPO	bigdecimal
reportData_CSR	bigdecimal
reportData_CTR	bigdecimal
reportData_clickCommission	bigdecimal
reportData_eCPC	bigdecimal
reportData_eCPM	bigdecimal
reportData_fixedCommission	bigdecimal
reportData_impressionCommission	bigdecimal
reportData_leadCommission	bigdecimal
reportData_leadCount	integer
reportData_orderAmount	bigdecimal
reportData_overallClickCount	integer
reportData_overallImpressionCount	integer
reportData_saleCommission	bigdecimal
reportData_saleCount	integer
reportData_totalCommission	bigdecimal
reportData_uniqueClickCount	integer
reportData_uniqueImpressionCount	integer

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_AffiliateSitePerformance AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.AffiliateSitePerformance (
			campaignID => 18141,
			affiliateSiteID => NULL,
			dateFrom => NULL,
			dateTo => NULL
		)
	) AS x

AffiliateSiteTypes

Affiliate site types
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
ID	long
name	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_AffiliateSiteTypes AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.AffiliateSiteTypes ()
	) AS x

AffiliateSites

Affiliate sites
Parameter
<ID> (optional): Affiliate site id
<affiliateSiteCategoryID> (optional): Affiliate site category id
<affiliateSiteTypeID> (optional): Affiliate site type id
<assignmentDateFrom> (optional): Assignment date from
<assignmentDateTo> (optional): Assignment date to
<assignmentStatus> (optional): Assignment status. Possible values: pending, accepted, rejected, onhold, signedout
<campaignID> (optional): Campaign id
<modificationDateFrom> (optional): Modification date from
<modificationDateTo> (optional): Modification date to
<query> (optional): Affiliate site query
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	long
name	string
URL	string
info_assignmentDate	timestamp
info_assignmentStatus	string
info_campaignSegment_ID	long
info_campaignSegment_name	string
info_category_ID	integer
info_category_name	string
info_description	string
info_modificationDate	timestamp
info_tradeRulesEnabled	string
info_type_ID	integer
info_type_name	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_AffiliateSites AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.AffiliateSites (
			campaignID => 18141,
			ID => NULL,
			query => NULL,
			affiliateSiteTypeID => NULL,
			affiliateSiteCategoryID => NULL,
			assignmentStatus => NULL,
			assignmentDateFrom => NULL,
			assignmentDateTo => NULL,
			modificationDateFrom => NULL,
			modificationDateTo => NULL
		)
	) AS x

Attributions

Attributions
Parameter
<conversionTransactionID> (optional): Lead and sale transaction id
<conversionTransaction_table> (optional): Table with column ID containing lead and sale transaction ids
<campaignID> (optional): Lead and sale transactions for campaign id
<characteristic> (optional): Lead and sale transactions with characteristic
<registrationDateFrom> (optional): Lead and sale transactions with registration date from
<registrationDateTo> (optional): Lead and sale transactions with registration date to
<transactionStatus> (optional): Lead and sale transactions with status. Possible values: pending, accepted and rejected
<transactionType> (optional): Lead and sale transactions with type. Possible values: click, lead and sale
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
conversionTransactionID	long
affiliateSiteID	long
commission	bigdecimal
position	string
touchpoints	long

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_Attributions AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.Attributions (
			conversionTransactionID => 539702714
		)
	) AS x

CampaignPerformance

Campaign performance statistics
Parameter
<campaignID> (optional): Campaign id
<dateFrom> (optional): Date from
<dateTo> (optional): Date to
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
overallImpressionCount	integer
uniqueImpressionCount	integer
impressionCommission	bigdecimal
overallClickCount	integer
uniqueClickCount	integer
clickCommission	bigdecimal
leadCount	integer
leadCommission	bigdecimal
saleCount	integer
saleCommission	bigdecimal
fixedCommission	bigdecimal
CTR	bigdecimal
CLR	bigdecimal
CSR	bigdecimal
CPO	bigdecimal
eCPM	bigdecimal
eCPC	bigdecimal
orderAmount	bigdecimal
totalCommission	bigdecimal

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_CampaignPerformance AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.CampaignPerformance (
			campaignID => 18141,
			dateFrom => NULL,
			dateTo => NULL
		)
	) AS x

CampaignSegments

Campaign segments
Parameter
<campaignID> (optional): Campaign id
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	long
name	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_CampaignSegments AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.CampaignSegments (
			campaignID => 18141
		)
	) AS x

Campaigns

Campaigns
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
ID	long
name	string
URL	string
info_campaignDescription	string
info_category_ID	integer
info_category_name	string
info_characteristics	string
info_clickToConversion	string
info_policyCashbackStatus	string
info_policyDiscountCodeStatus	string
info_policyEmailMarketingStatus	string
info_policySearchEngineMarketingStatus	string
info_shopDescription	string
info_startDate	date
info_stopDate	date
info_targetGroup	string
info_timeZone	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_Campaigns AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.Campaigns ()
	) AS x

ClickTransactions

Click transactions
Parameter
<ID> (optional): Click transaction id
<campaignID> (optional): Campaign id
<registrationDateFrom> (optional): Registration date from
<registrationDateTo> (optional): Registration date to
<transactionStatus> (optional): Transaction status. Possible values: pending, accepted and rejected
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	long
IP	string
affiliateSite_ID	long
affiliateSite_URL	string
affiliateSite_info	string
affiliateSite_name	string
commission	bigdecimal
currency	string
refererURL	string
registrationDate	timestamp
transactionStatus	string
transactionType	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_ClickTransactions AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.ClickTransactions (
			campaignID => 18141,
			ID => NULL,
			transactionStatus => NULL,
			registrationDateFrom => NULL,
			registrationDateTo => NULL
		)
	) AS x

ConversionTransactions

Lead and sale transactions
Parameter
<ID> (optional): Lead and sale transaction id
<campaignID> (optional): Campaign id
<characteristic> (optional): Characteristic
<registrationDateFrom> (optional): Registration date from
<registrationDateTo> (optional): Registration date to
<transactionStatus> (optional): Transaction status. Possible values: pending, accepted and rejected
<transactionType> (optional): Transaction type. Possible values: click, lead and sale
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	long
IP	string
affiliateSite_ID	long
affiliateSite_URL	string
affiliateSite_info	string
affiliateSite_name	string
assessmentDate	string
campaignProduct_ID	long
campaignProduct_name	string
campaign_ID	long
campaign_URL	string
campaign_info	string
campaign_name	string
characteristic	string
clickToConversion	string
commission	bigdecimal
countryCode	string
currency	string
description	string
numAttributedTouchPoints	integer
numTouchPoints	integer
orderAmount	bigdecimal
originatingClickDate	timestamp
registrationDate	timestamp
rejectionReason	string
transactionStatus	string
transactionType	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_ConversionTransactions AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.ConversionTransactions (
			campaignID => 18141,
			ID => NULL,
			transactionType => NULL,
			transactionStatus => NULL,
			characteristic => NULL,
			registrationDateFrom => NULL,
			registrationDateTo => NULL
		)
	) AS x

MaterialBannerDimensions

Banner dimension items as used for the available banner material
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
ID	long
width	integer
height	integer
isCommon	boolean
isMobile	boolean

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_MaterialBannerDimensions AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.MaterialBannerDimensions ()
	) AS x

MaterialBannerImageItems

Image banner items
Parameter
<ID> (optional): Material item id
<campaignID> (optional): Campaign id
<isVisibleForAffiliates> (optional): Is visible for affiliates
<materialBannerDimensionID> (optional): Material banner dimension id
<materialCategoryID> (optional): Material category id
<query> (optional): Material item query
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	long
name	string
creationDate	timestamp
modificationDate	timestamp
alternativeText	string
isVisibleForAffiliates	boolean
materialCategory_ID	long
materialCategory_name	string
materialBannerDimension_ID	long
materialBannerDimension_width	integer
materialBannerDimension_height	integer
materialBannerDimension_isCommon	boolean
materialBannerDimension_isMobile	boolean
targetURL	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_MaterialBannerImageItems AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.MaterialBannerImageItems (
			campaignID => 18141,
			ID => NULL,
			query => NULL,
			materialCategoryID => NULL,
			materialBannerDimensionID => NULL,
			isVisibleForAffiliates => NULL
		)
	) AS x

MaterialCategories

Material categories
Parameter
<campaignID> (optional): Campaign id
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	long
name	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_MaterialCategories AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.MaterialCategories (
			campaignID => 18141
		)
	) AS x

MaterialHTMLItems

Campaign HTML advertorial items
Parameter
<ID> (optional): Material item id
<campaignID> (optional): Campaign id
<isVisibleForAffiliates> (optional): Is visible for affiliates
<materialBannerDimensionID> (optional): Material banner dimension id
<materialCategoryID> (optional): Material category id
<query> (optional): Material item query
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	long
name	string
creationDate	timestamp
modificationDate	timestamp
HTMLContent	string
height	integer
isVisibleForAffiliates	boolean
materialCategory_ID	long
materialCategory_name	string
targetURL	string
width	integer

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_MaterialHTMLItems AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.MaterialHTMLItems (
			campaignID => 18141,
			ID => NULL,
			query => NULL,
			materialCategoryID => NULL,
			materialBannerDimensionID => NULL,
			isVisibleForAffiliates => NULL
		)
	) AS x

MaterialIncentiveOfferItems

Consumer offer items
Parameter
<ID> (optional): Material item id
<campaignID> (optional): Campaign id
<isVisibleForAffiliates> (optional): Is visible for affiliates
<materialBannerDimensionID> (optional): Material banner dimension id
<materialCategoryID> (optional): Material category id
<query> (optional): Material item query
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	string
name	string
creationDate	string
modificationDate	string
conditions	string
description	string
discountFixed	string
discountVariable	string
isVisibleForAffiliates	string
materialCategory_ID	string
materialCategory_name	string
title	string
validFromDate	string
validToDate	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_MaterialIncentiveOfferItems AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.MaterialIncentiveOfferItems (
			campaignID => 18141,
			ID => NULL,
			query => NULL,
			materialCategoryID => NULL,
			materialBannerDimensionID => NULL,
			isVisibleForAffiliates => NULL
		)
	) AS x

MaterialIncentiveVoucherItems

Voucher items
Parameter
<ID> (optional): Material item id
<campaignID> (optional): Campaign id
<isVisibleForAffiliates> (optional): Is visible for affiliates
<materialBannerDimensionID> (optional): Material banner dimension id
<materialCategoryID> (optional): Material category id
<query> (optional): Material item query
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	string
name	string
creationDate	string
modificationDate	string
conditions	string
description	string
discountFixed	string
discountVariable	string
isVisibleForAffiliates	string
materialCategory_ID	string
materialCategory_name	string
title	string
validFromDate	string
validToDate	string
voucherCode	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_MaterialIncentiveVoucherItems AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.MaterialIncentiveVoucherItems (
			campaignID => 18141,
			ID => NULL,
			query => NULL,
			materialCategoryID => NULL,
			materialBannerDimensionID => NULL,
			isVisibleForAffiliates => NULL
		)
	) AS x

MaterialTextItems

Campaign text link items
Parameter
<ID> (optional): Material item id
<campaignID> (optional): Campaign id
<isVisibleForAffiliates> (optional): Is visible for affiliates
<materialBannerDimensionID> (optional): Material banner dimension id
<materialCategoryID> (optional): Material category id
<query> (optional): Material item query
<campaign_table> (optional): Table with column ID containing campaign ids
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
campaignID	long
ID	long
name	string
creationDate	timestamp
modificationDate	timestamp
isVisibleForAffiliates	boolean
linkCaption	string
linkText	string
materialCategory_ID	long
materialCategory_name	string
targetURL	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_MaterialTextItems AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.MaterialTextItems (
			campaignID => 18141,
			ID => NULL,
			query => NULL,
			materialCategoryID => NULL,
			materialBannerDimensionID => NULL,
			isVisibleForAffiliates => NULL
		)
	) AS x

Touchpoints

Touchpoints
Parameter
<conversionTransactionID> (optional): Lead and sale transaction id
<conversionTransaction_table> (optional): Table with column ID containing lead and sale transaction ids
<campaignID> (optional): Lead and sale transactions for campaign id
<characteristic> (optional): Lead and sale transactions with characteristic
<registrationDateFrom> (optional): Lead and sale transactions with registration date from
<registrationDateTo> (optional): Lead and sale transactions with registration date to
<transactionStatus> (optional): Lead and sale transactions with status. Possible values: pending, accepted and rejected
<transactionType> (optional): Lead and sale transactions with type. Possible values: click, lead and sale
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type
conversionTransactionID	long
affiliateSiteID	long
registrationDate	timestamp
numImpressions	integer
numClicks	integer
isAttributed	boolean
commission	bigdecimal
position	string

Example

SQL

CREATE VIEW tradetracker_merchant_examples.example_Touchpoints AS 
	SELECT * 
	FROM (
		CALL tradetracker_merchant.Touchpoints (
			conversionTransactionID => 539702714
		)
	) AS x