Skip to main content
Skip table of contents

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

Affiliate

Affiliate
Parameter
<initialDate> (required): The initial date
<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

Report date

affiliateId

integer

Affiliate Id

affiliateName

string

Affiliate Name

views

integer

Count of views

clicks

integer

Count of clicks

transactionsTotal

integer

Transactions Total

transactionsPending

integer

Transactions Pending

transactionsCanceled

integer

Transactions Canceled

transactionsApproved

integer

Transactions Approved

leadsTotal

integer

Leads Total

leadsPending

integer

Leads Pending

leadsCanceled

integer

Leads Canceled

leadsApproved

integer

Leads Approved

salesvarTotal

integer

Salevar Total

salesvarPending

integer

Salesvar Pending

salesvarCanceled

integer

salesvar Canceled

salesvarApproved

integer

salesvar Approved

salesfixTotal

integer

salesfix Total

salesfixPending

integer

salesfix Pending

salesfixCanceled

integer

salesfix Canceled

salesfixApproved

integer

salesfix Approved

commissionTransactionsTotal

bigdecimal

Commission Transactions Total

commissionTransactionsPending

bigdecimal

Commission Transactions Pending

commissionTransactionsCanceled

bigdecimal

Commission Transactions Canceled

commissionTransactionsApproved

bigdecimal

Commission Transactions Approved

commissionLeadsTotal

bigdecimal

Commission Leads Total

commissionLeadsPending

bigdecimal

Commission Leads Pending

commissionLeadsCanceled

bigdecimal

Commission Leads Canceled

commissionLeadsApproved

bigdecimal

Commission Leads Approved

commissionSalesvarTotal

bigdecimal

Commission Salesvar Total

commissionSalesvarPending

bigdecimal

Commission Salesvar Pending

commissionSalesvarCanceled

bigdecimal

Commission Salesvar Canceled

commissionSalesvarApproved

bigdecimal

Commission Salesvar Approved

commissionSalesfixTotal

bigdecimal

Commission Salesfix Total

commissionSalesfixPending

bigdecimal

Commission Salesfix Pending

commissionSalesfixCanceled

bigdecimal

Commission Salesfix Canceled

commissionSalesfixApproved

bigdecimal

Commission Salesfix Approved

valueTotal

bigdecimal

Value Total

valuePending

bigdecimal

Value Pending

valueCanceled

bigdecimal

Value Canceled

valueApproved

bigdecimal

Value Approved

SQL
CREATE VIEW retailads_examples.example_Affiliate
AS 
SELECT * FROM retailads.Affiliate (
	initialDate => CurDate(),
	preview => TRUE
)

LeadsSales

Leads Sales
Parameter
<initialDate> (required): The initial date
<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

orderId

string

Order Id

programName

string

Program Name

programId

string

Program Id

adspaceName

string

Adspace Name

adspaceId

string

Adspace Id

admediaId

string

Admedia Id

type

string

Type

additionalInformation

string

Additional Information

timeConversion

timestamp

Time Conversion

timeLastUpdate

timestamp

Time Last Update

timePayout

string

Time Payout

timeClick

timestamp

Time Click

referrer

string

Referrer

status

string

Status

statusInfo

string

Status Info

commission

bigdecimal

Commission

basketValue

bigdecimal

Basket Value

basketCount

integer

Basket Count

currency

string

Currency

commissionCategory

string

Commission Category

commissionCategoryId

string

Commission Category Id

commissionCategoryName

string

Commission Category Name

commissionOriginal

bigdecimal

Commission Original

commissionNetworkValue

bigdecimal

Commission Network Value

basketValueOriginal

bigdecimal

Original Basket Value

adspaceUrl

string

Adspace Url

vouchercode

string

Voucher code

trackingContactType

string

Tracking Contact Type

trackingType

string

Tracking Type

adspaceIdOriginal

string

Adspace Id Original

adspaceNameOriginal

string

Adspace Name Original

deviceType

string

Device Type

SQL
CREATE VIEW retailads_examples.example_LeadsSales
AS 
SELECT * FROM retailads.LeadsSales (
	initialDate => CurDate(),
	preview => TRUE
)
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.