Webgains API Reference

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefix in their names.

AdvertiserTopPerformers

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

Attribute	Type	Description
reportDate	date	Date of Report
id	string	Id
image_url	string	Image url
name	string	Name
currency	string	Currency
commissionTotals	bigdecimal	Commission Totals
transactionTotals	bigdecimal	Transaction Totals
transactionNumber	bigdecimal	Transaction Number
viewTotals	bigdecimal	View Totals
clickTotals	bigdecimal	Click Totals
ctr	bigdecimal	CTR
ephc	bigdecimal	EPHC
aov	bigdecimal	AOV
convRate	bigdecimal	Conversion Rate

Example

SQL

CREATE VIEW webgains_examples.example_AdvertiserTopPerformers
AS 
SELECT * FROM webgains.AdvertiserTopPerformers (
    preview => TRUE
)

Transactions

Transactions
Parameter
<starttimestamp> (required): Earliest datetime to retrieve transactions from
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	Transaction Id
date	timestamp	Date
campaign_id	string	Campaign Id
event_id	string	Event Id
customer_id	string	Customer Id
order_reference	string	Order Reference
voucher_code	string	Voucher Code
delayed_until_date	timestamp	Delayed Until Date
value	bigdecimal	Value
commission	bigdecimal	Commission
currency	string	Currency
status	string	Status
comment	string	Comment

Example

SQL

CREATE VIEW webgains_examples.example_Transactions
AS 
SELECT * FROM webgains.Transactions (
	starttimestamp => TimestampAdd (SQL_TSI_DAY, -1, CurDate()),
    preview => TRUE
)