Finance
Finance
fiView
CEH Core
The fiView event reports a page view and is a special event because it’s required by smartserve.js for data collection and processing.
It’s therefore essential that every page emits an fiView event and that it’s emitted before any other event.
|
Any CEH events emitted before the first |
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
type (String) |
Can be either home, category, product, checkout, transaction, help, contact or other. |
|
subtypes (String[]) |
An unordered list of subtypes to describe the view. |
|
environment (String) |
Reports the environment, that is, development, staging or production. |
|
language (String) |
The selected language for the view. |
|
country (String) |
The selected country for the view. |
|
siteVersion (String) |
The selected site version for the view (for example, desktop, mobile, tablet) |
|
Example JavaScript
uv.emit('fiView', {
type: 'category',
subtypes: [
'Mortgages',
'Fixed Rate'
],
environment: 'production',
language: 'English',
country: 'United Kingdom',
siteVersion: 'desktop'
})fiBasketTransactionSummary
CEH Core
Emitted for each time a user transacts.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
basket.total.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.total.currency (String) |
The ISO 4217 currency (for example, |
|
transaction.id (String) |
An Id unique to the transaction |
|
basket.id (String) |
Should be an ID unique to the basket. |
|
basket.subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
basket.subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
basket.total (Price) |
The total cost of the basket including tax and discounts. |
|
basket.quantity (Number) |
The number of items in the basket. |
|
basket.discount (Price) |
The amount discounted from vouchers or promotions. |
|
basket.discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.discount.currency (String) |
The ISO 4217 currency (for example, |
|
basket.tax (Price) |
The total tax for the basket. |
|
basket.tax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.tax.currency (String) |
The ISO 4217 currency (for example, |
|
basket.subtotalIncludingTax (Price) |
The total cost of the basket including tax, excluding discounts. |
|
basket.subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
transaction.firstTransaction (Boolean) |
True only if this is the first ever transaction for the user |
|
transaction.paymentType (String) |
The type of payment |
|
transaction.billingAddress.addressee (String) |
Full name of the person for whom the address is for |
|
transaction.billingAddress.company (String) |
The name of the company |
|
transaction.billingAddress.lines (String[]) |
An array of address lines NOT including city, region, postcode or country (maximum of 3 lines allowed) |
|
transaction.billingAddress.locality (String) |
The town or city |
|
transaction.billingAddress.region (String) |
E.g state in the US, county in the UK |
|
transaction.billingAddress.postalCode (String) |
Can be the country equivalent code (for example, zip code for the U.S) |
|
transaction.billingAddress.country (String) |
The name of the country |
|
transaction.billingAddress.countryCode (String) |
An ISO 3166-1 alpha-2 country code |
|
transaction.parentId (String) |
If the transaction is an amendment to a previous transaction, should be the Id of the parent transaction |
|
Example JavaScript
uv.emit('fiBasketTransactionSummary', {
basket: {
id: 'BASK123',
subtotal: {
value: 9.99,
currency: 'USD'
},
total: {
value: 9.99,
currency: 'USD'
},
quantity: 10,
discount: {
value: 9.99,
currency: 'USD'
},
tax: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
}
},
transaction: {
id: '83748372',
firstTransaction: true,
paymentType: 'paypal',
billingAddress: {
addressee: 'John Smith',
company: 'Amce Inc',
lines: [
'Flat 12',
'123 High Street'
],
locality: 'London',
region: 'New York',
postalCode: '10010',
country: 'United States',
countryCode: 'US'
},
parentId: '83748371'
}
})fiUser
Optional
User events report metadata associated with a user.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
user.id (String) |
A unique user Id. Can also be a hash of the username and/or email address |
|
user.title (String) |
The user’s title |
|
user.firstName (String) |
The user’s first name |
|
user.lastName (String) |
The user’s last name |
|
user.gender (String) |
The user’s gender. Can be |
|
user.username (String) |
The username for the user |
|
user.email (String) |
The user’s primary email address |
|
user.firstSession (Boolean) |
True if it’s the user’s first session |
|
user.hasTransacted (Boolean) |
True if the user has completed 1 or more transactions |
|
user.loyalty.id (String) |
Loyalty program membership number |
|
user.loyalty.tier (String) |
The level of the loyalty program this user holds |
|
user.loyalty.tierPoints (Number) |
The number of tier points |
|
user.loyalty.membershipType (String) |
The type of loyalty membership |
|
user.loyalty.membershipPoints (Number) |
The number of points from this membership |
|
user.address.addressee (String) |
Full name of the person for whom the address is for |
|
user.address.company (String) |
The name of the company |
|
user.address.lines (String[]) |
An array of address lines NOT including city, region, postcode or country (maximum of 3 lines allowed) |
|
user.address.locality (String) |
The town or city |
|
user.address.region (String) |
E.g state in the US, county in the UK |
|
user.address.postalCode (String) |
Can be the country equivalent code (for example, zip code for the U.S) |
|
user.address.country (String) |
The name of the country |
|
user.address.countryCode (String) |
An ISO 3166-1 alpha-2 country code |
|
user.isGuest (String) |
True if the user is a guest user without a registered account |
|
user.age (Number) |
The user’s age in years |
|
user.phoneNumber (String) |
The user’s phone number. Should be formatted without spaces, braces, or hyphens |
|
user.countryCallingCode (String) |
The country calling code for the given phone number, formatted to include the |
|
user.device (String) |
Device the user is browsing on - for example |
|
user.phone (String) |
The user’s phone number. |
|
user.dateOfBirth (String) |
The user’s date of birth. |
|
Example JavaScript
uv.emit('fiUser', {
user: {
id: '2861102bace6e6620948564f0ce0a7cd',
title: 'Mr',
firstName: 'John',
lastName: 'Smith',
gender: 'Male',
username: 'JohnSmith',
email: 'john@johnsmith.com',
firstSession: null,
hasTransacted: true,
loyalty: {
id: '8989752-223',
tier: 'silver',
tierPoints: null,
membershipType: 'Clearsky Rewards',
membershipPoints: null
},
address: {
addressee: 'John Smith',
company: 'Amce Inc',
lines: [
'Flat 12',
'123 High Street'
],
locality: 'London',
region: 'New York',
postalCode: '10010',
country: 'United States',
countryCode: 'US'
},
isGuest: 'true',
age: 42,
phoneNumber: '2121234567',
countryCallingCode: '1',
device: 'kiosk',
phone: '555-555-5555',
dateOfBirth: '12/31/1982'
}
})fiBasketItem
Optional
Emitted for every line item in a basket shown to the visitor either as an inline mini basket or in a view that shows only the basket. If the visitor’s basket is changed in any way, events representing each line item are emitted again.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
basket.id (String) |
Should be an ID unique to the basket. |
|
basket.subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
basket.subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
basket.total (Price) |
The total cost of the basket including tax and discounts. |
|
basket.total.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.total.currency (String) |
The ISO 4217 currency (for example, |
|
basket.quantity (Number) |
The number of items in the basket. |
|
basket.discount (Price) |
The amount discounted from vouchers or promotions. |
|
basket.discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.discount.currency (String) |
The ISO 4217 currency (for example, |
|
basket.tax (Price) |
The total tax for the basket. |
|
basket.tax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.tax.currency (String) |
The ISO 4217 currency (for example, |
|
basket.subtotalIncludingTax (Price) |
The total cost of the basket including tax, excluding discounts. |
|
basket.subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
product.name (String) |
The product name. |
|
product.category (String[]) |
An array of categories, highest level first, defining the product. Recommended to not excede 4 items long. |
|
product.productType (String) |
The type of the product |
|
product.insurance.coverDuration (Number) |
The duration of the cover, in days. |
|
product.insurance.paymentFrequency (String) |
The frequency of when the payments happen. |
|
product.insurance.excess (Price) |
The excess required. |
|
product.insurance.excess.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.insurance.excess.currency (String) |
The ISO 4217 currency (for example, |
|
product.savings.aer (Number) |
The annual equivalent rate. Representats the interest rate if it was ompounded and paid. in one sum annualy. |
|
product.savings.minimumDeposit (Number) |
Minimum deposit value required to apply for the product. |
|
product.savings.maximumDeposit (Number) |
Maximum depoist value. |
|
product.savings.monthlyAccountFees (Number) |
Account fees of the product. |
|
product.savings.depositValue (Number) |
Amount deposited to create the account. |
|
product.mortage.interestRateType (String) |
The type of the interest rate. |
|
product.mortage.interestRate (Number) |
The interest rate in percent. |
|
product.mortage.bookingFee (Price) |
Fees upon booking. |
|
product.mortage.bookingFee.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.bookingFee.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.completionFee (Price) |
Fees payable upon full mortgage repayment. |
|
product.mortage.completionFee.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.completionFee.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.maxLoanToValue (Price) |
Maximum loan amount available as a percent of the property. |
|
product.mortage.maxLoanToValue.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.maxLoanToValue.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.deposit (Price) |
The deposit value. |
|
product.mortage.deposit.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.deposit.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.loanAmount (Price) |
The amount borrowed. |
|
product.mortage.loanAmount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.loanAmount.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.repaymentTerm (Number) |
The set repayment term in years. |
|
product.mortage.actualLoanToValue (Number) |
Value of the loan relative to the value of the property. |
|
product.mortage.baseSalary (Price) |
Annual base salary. |
|
product.mortage.baseSalary.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.baseSalary.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.expectedBonus (Price) |
Any additional expected salary that is not guaranteed. |
|
product.mortage.expectedBonus.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.expectedBonus.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.firstTimeBuyer (Boolean) |
Describes whether the visitor is a first time buyer. |
|
product.loan.loanValue (Price) |
The value of the loan taken. |
|
product.loan.loanValue.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.loanValue.currency (String) |
The ISO 4217 currency (for example, |
|
product.loan.startDate (Epochtimems) |
The start date of the loan. |
|
product.loan.endDate (Epochtimems) |
The end date of the loan. |
|
product.loan.loanTerm (Number) |
Duration of the repayment term in days. |
|
product.loan.paymentFrequency (String) |
The frequency of when the payments happen. |
|
product.loan.apr (Number) |
The annual percentage rate. |
|
product.loan.loanFees (Price) |
Fees payable during arrangement |
|
product.loan.loanFees.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.loanFees.currency (String) |
The ISO 4217 currency (for example, |
|
product.loan.completionFees (Price) |
Fees payable on completion |
|
product.loan.completionFees.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.completionFees.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.shareName (String) |
The name of the share. |
|
product.investment.sharePrice (Price) |
The price of the share. |
|
product.investment.sharePrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.sharePrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.openingPrice (Price) |
The opening price is the price at which a security first trades upon the opening of an exchange. |
|
product.investment.openingPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.openingPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.highPrice (Price) |
Today’s high is the highest price at which a stock traded during the course of the day. |
|
product.investment.highPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.highPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.lowPrice (Price) |
Today’s low is the lowest price at which a stock traded during the course of the day. |
|
product.investment.lowPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.lowPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.closePrice (Price) |
The final price at which a security is traded on in a previous trading day. |
|
product.investment.closePrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.closePrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.currency (String) |
The share currency. |
|
product.investment.symbol (String) |
The share symbol. |
|
product.investment.securityType (String) |
The security type of the share. |
|
product.investment.exchange (String) |
The location where the product is being traded. |
|
product.investment.fundType (String) |
The type of the fund. |
|
product.investment.fundManager (String) |
The manager of the fund. |
|
product.investment.launchDate (Epochtimems) |
The launch date of the fund. |
|
product.investment.fundSize (Price) |
The size of the fund. |
|
product.investment.fundSize.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.fundSize.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.holdingsAmount (Number) |
The amount of holdings. |
|
product.productId (String) |
ID uniquely identifying the finance product. |
|
product.price (Price) |
The price of the product after discounts. |
|
product.price.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.price.currency (String) |
The ISO 4217 currency (for example, |
|
product.originalPrice (Price) |
The original price of the product. |
|
product.originalPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.originalPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.onSale (Boolean) |
Is item on sale? |
|
product.categories (String[]) |
A list of one or more product categories this product belongs to. Each category is a full path of a category where each level is separated by ' > '. |
|
quantity (Number) |
The number of products described by the line item. |
|
subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
discount (Price) |
The amount discounted from vouchers or promotions for the product. |
|
discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
discount.currency (String) |
The ISO 4217 currency (for example, |
|
subtotalIncludingTax (Price) |
The price of the item including tax, excluding discounts. |
|
subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
Example JavaScript
uv.emit('fiBasketItem', {
basket: {
id: 'BASK123',
subtotal: {
value: 9.99,
currency: 'USD'
},
total: {
value: 9.99,
currency: 'USD'
},
quantity: 10,
discount: {
value: 9.99,
currency: 'USD'
},
tax: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
}
},
product: {
name: 'Finance product A',
category: [
'Car Insurance',
'European cover'
],
productType: 'loan',
insurance: {
coverDuration: 210,
paymentFrequency: 'annual',
excess: {
value: 9.99,
currency: 'USD'
}
},
savings: {
aer: 1.25,
minimumDeposit: 1000,
maximumDeposit: 100000,
monthlyAccountFees: 5,
depositValue: 2000
},
mortage: {
interestRateType: 'variable',
interestRate: 4.79,
bookingFee: {
value: 9.99,
currency: 'USD'
},
completionFee: {
value: 9.99,
currency: 'USD'
},
maxLoanToValue: {
value: 9.99,
currency: 'USD'
},
deposit: {
value: 9.99,
currency: 'USD'
},
loanAmount: {
value: 9.99,
currency: 'USD'
},
repaymentTerm: 25,
actualLoanToValue: null,
baseSalary: {
value: 9.99,
currency: 'USD'
},
expectedBonus: {
value: 9.99,
currency: 'USD'
},
firstTimeBuyer: null
},
loan: {
loanValue: {
value: 9.99,
currency: 'USD'
},
startDate: 1461236327,
endDate: 1461236361,
loanTerm: 1325,
paymentFrequency: 'monthly',
apr: 4.5,
loanFees: {
value: 9.99,
currency: 'USD'
},
completionFees: {
value: 9.99,
currency: 'USD'
}
},
investment: {
shareName: 'BT',
sharePrice: {
value: 9.99,
currency: 'USD'
},
openingPrice: {
value: 9.99,
currency: 'USD'
},
highPrice: {
value: 9.99,
currency: 'USD'
},
lowPrice: {
value: 9.99,
currency: 'USD'
},
closePrice: {
value: 9.99,
currency: 'USD'
},
currency: 'USD',
symbol: 'BEL20',
securityType: 'index',
exchange: 'Brussels',
fundType: 'UCITS',
fundManager: 'Paul Gibson',
launchDate: 1461236327,
fundSize: {
value: 9.99,
currency: 'USD'
},
holdingsAmount: 50
},
productId: 'abc123',
price: {
value: 9.99,
currency: 'USD'
},
originalPrice: {
value: 9.99,
currency: 'USD'
},
onSale: null,
categories: [
'Car insurance > European cover',
'Special offers'
]
},
quantity: 2,
subtotal: {
value: 9.99,
currency: 'USD'
},
discount: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
}
})fiBasketItemAction
Optional
Emitted for every interaction with the basket, using the action field to specify whether a line item was added or removed.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
basket.id (String) |
Should be an ID unique to the basket. |
|
basket.subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
basket.subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
basket.total (Price) |
The total cost of the basket including tax and discounts. |
|
basket.total.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.total.currency (String) |
The ISO 4217 currency (for example, |
|
basket.quantity (Number) |
The number of items in the basket. |
|
basket.discount (Price) |
The amount discounted from vouchers or promotions. |
|
basket.discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.discount.currency (String) |
The ISO 4217 currency (for example, |
|
basket.tax (Price) |
The total tax for the basket. |
|
basket.tax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.tax.currency (String) |
The ISO 4217 currency (for example, |
|
basket.subtotalIncludingTax (Price) |
The total cost of the basket including tax, excluding discounts. |
|
basket.subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
product.name (String) |
The product name. |
|
product.category (String[]) |
An array of categories, highest level first, defining the product. Recommended to not excede 4 items long. |
|
product.productType (String) |
The type of the product |
|
product.insurance.coverDuration (Number) |
The duration of the cover, in days. |
|
product.insurance.paymentFrequency (String) |
The frequency of when the payments happen. |
|
product.insurance.excess (Price) |
The excess required. |
|
product.insurance.excess.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.insurance.excess.currency (String) |
The ISO 4217 currency (for example, |
|
product.savings.aer (Number) |
The annual equivalent rate. Representats the interest rate if it was ompounded and paid. in one sum annualy. |
|
product.savings.minimumDeposit (Number) |
Minimum deposit value required to apply for the product. |
|
product.savings.maximumDeposit (Number) |
Maximum depoist value. |
|
product.savings.monthlyAccountFees (Number) |
Account fees of the product. |
|
product.savings.depositValue (Number) |
Amount deposited to create the account. |
|
product.mortage.interestRateType (String) |
The type of the interest rate. |
|
product.mortage.interestRate (Number) |
The interest rate in percent. |
|
product.mortage.bookingFee (Price) |
Fees upon booking. |
|
product.mortage.bookingFee.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.bookingFee.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.completionFee (Price) |
Fees payable upon full mortgage repayment. |
|
product.mortage.completionFee.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.completionFee.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.maxLoanToValue (Price) |
Maximum loan amount available as a percent of the property. |
|
product.mortage.maxLoanToValue.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.maxLoanToValue.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.deposit (Price) |
The deposit value. |
|
product.mortage.deposit.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.deposit.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.loanAmount (Price) |
The amount borrowed. |
|
product.mortage.loanAmount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.loanAmount.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.repaymentTerm (Number) |
The set repayment term in years. |
|
product.mortage.actualLoanToValue (Number) |
Value of the loan relative to the value of the property. |
|
product.mortage.baseSalary (Price) |
Annual base salary. |
|
product.mortage.baseSalary.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.baseSalary.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.expectedBonus (Price) |
Any additional expected salary that is not guaranteed. |
|
product.mortage.expectedBonus.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.expectedBonus.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.firstTimeBuyer (Boolean) |
Describes whether the visitor is a first time buyer. |
|
product.loan.loanValue (Price) |
The value of the loan taken. |
|
product.loan.loanValue.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.loanValue.currency (String) |
The ISO 4217 currency (for example, |
|
product.loan.startDate (Epochtimems) |
The start date of the loan. |
|
product.loan.endDate (Epochtimems) |
The end date of the loan. |
|
product.loan.loanTerm (Number) |
Duration of the repayment term in days. |
|
product.loan.paymentFrequency (String) |
The frequency of when the payments happen. |
|
product.loan.apr (Number) |
The annual percentage rate. |
|
product.loan.loanFees (Price) |
Fees payable during arrangement |
|
product.loan.loanFees.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.loanFees.currency (String) |
The ISO 4217 currency (for example, |
|
product.loan.completionFees (Price) |
Fees payable on completion |
|
product.loan.completionFees.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.completionFees.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.shareName (String) |
The name of the share. |
|
product.investment.sharePrice (Price) |
The price of the share. |
|
product.investment.sharePrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.sharePrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.openingPrice (Price) |
The opening price is the price at which a security first trades upon the opening of an exchange. |
|
product.investment.openingPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.openingPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.highPrice (Price) |
Today’s high is the highest price at which a stock traded during the course of the day. |
|
product.investment.highPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.highPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.lowPrice (Price) |
Today’s low is the lowest price at which a stock traded during the course of the day. |
|
product.investment.lowPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.lowPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.closePrice (Price) |
The final price at which a security is traded on in a previous trading day. |
|
product.investment.closePrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.closePrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.currency (String) |
The share currency. |
|
product.investment.symbol (String) |
The share symbol. |
|
product.investment.securityType (String) |
The security type of the share. |
|
product.investment.exchange (String) |
The location where the product is being traded. |
|
product.investment.fundType (String) |
The type of the fund. |
|
product.investment.fundManager (String) |
The manager of the fund. |
|
product.investment.launchDate (Epochtimems) |
The launch date of the fund. |
|
product.investment.fundSize (Price) |
The size of the fund. |
|
product.investment.fundSize.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.fundSize.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.holdingsAmount (Number) |
The amount of holdings. |
|
product.productId (String) |
ID uniquely identifying the finance product. |
|
product.price (Price) |
The price of the product after discounts. |
|
product.price.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.price.currency (String) |
The ISO 4217 currency (for example, |
|
product.originalPrice (Price) |
The original price of the product. |
|
product.originalPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.originalPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.onSale (Boolean) |
Is item on sale? |
|
product.categories (String[]) |
A list of one or more product categories this product belongs to. Each category is a full path of a category where each level is separated by ' > '. |
|
quantity (Number) |
The number of products described by the line item. |
|
subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
discount (Price) |
The amount discounted from vouchers or promotions for the product. |
|
discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
discount.currency (String) |
The ISO 4217 currency (for example, |
|
subtotalIncludingTax (Price) |
The price of the item including tax, excluding discounts. |
|
subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
action (String) |
Can be either 'add', 'remove' for status changes. |
|
Example JavaScript
uv.emit('fiBasketItemAction', {
basket: {
id: 'BASK123',
subtotal: {
value: 9.99,
currency: 'USD'
},
total: {
value: 9.99,
currency: 'USD'
},
quantity: 10,
discount: {
value: 9.99,
currency: 'USD'
},
tax: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
}
},
product: {
name: 'Finance product A',
category: [
'Car Insurance',
'European cover'
],
productType: 'loan',
insurance: {
coverDuration: 210,
paymentFrequency: 'annual',
excess: {
value: 9.99,
currency: 'USD'
}
},
savings: {
aer: 1.25,
minimumDeposit: 1000,
maximumDeposit: 100000,
monthlyAccountFees: 5,
depositValue: 2000
},
mortage: {
interestRateType: 'variable',
interestRate: 4.79,
bookingFee: {
value: 9.99,
currency: 'USD'
},
completionFee: {
value: 9.99,
currency: 'USD'
},
maxLoanToValue: {
value: 9.99,
currency: 'USD'
},
deposit: {
value: 9.99,
currency: 'USD'
},
loanAmount: {
value: 9.99,
currency: 'USD'
},
repaymentTerm: 25,
actualLoanToValue: null,
baseSalary: {
value: 9.99,
currency: 'USD'
},
expectedBonus: {
value: 9.99,
currency: 'USD'
},
firstTimeBuyer: null
},
loan: {
loanValue: {
value: 9.99,
currency: 'USD'
},
startDate: 1461236327,
endDate: 1461236361,
loanTerm: 1325,
paymentFrequency: 'monthly',
apr: 4.5,
loanFees: {
value: 9.99,
currency: 'USD'
},
completionFees: {
value: 9.99,
currency: 'USD'
}
},
investment: {
shareName: 'BT',
sharePrice: {
value: 9.99,
currency: 'USD'
},
openingPrice: {
value: 9.99,
currency: 'USD'
},
highPrice: {
value: 9.99,
currency: 'USD'
},
lowPrice: {
value: 9.99,
currency: 'USD'
},
closePrice: {
value: 9.99,
currency: 'USD'
},
currency: 'USD',
symbol: 'BEL20',
securityType: 'index',
exchange: 'Brussels',
fundType: 'UCITS',
fundManager: 'Paul Gibson',
launchDate: 1461236327,
fundSize: {
value: 9.99,
currency: 'USD'
},
holdingsAmount: 50
},
productId: 'abc123',
price: {
value: 9.99,
currency: 'USD'
},
originalPrice: {
value: 9.99,
currency: 'USD'
},
onSale: null,
categories: [
'Car insurance > European cover',
'Special offers'
]
},
quantity: 2,
subtotal: {
value: 9.99,
currency: 'USD'
},
discount: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
},
action: 'add'
})fiBasketItemTransaction
Optional
Emitted for every line item within a transaction.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
basket.id (String) |
Should be an ID unique to the basket. |
|
basket.subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
basket.subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
basket.total (Price) |
The total cost of the basket including tax and discounts. |
|
basket.total.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.total.currency (String) |
The ISO 4217 currency (for example, |
|
basket.quantity (Number) |
The number of items in the basket. |
|
basket.discount (Price) |
The amount discounted from vouchers or promotions. |
|
basket.discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.discount.currency (String) |
The ISO 4217 currency (for example, |
|
basket.tax (Price) |
The total tax for the basket. |
|
basket.tax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.tax.currency (String) |
The ISO 4217 currency (for example, |
|
basket.subtotalIncludingTax (Price) |
The total cost of the basket including tax, excluding discounts. |
|
basket.subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
product.name (String) |
The product name. |
|
product.category (String[]) |
An array of categories, highest level first, defining the product. Recommended to not excede 4 items long. |
|
product.productType (String) |
The type of the product |
|
product.insurance.coverDuration (Number) |
The duration of the cover, in days. |
|
product.insurance.paymentFrequency (String) |
The frequency of when the payments happen. |
|
product.insurance.excess (Price) |
The excess required. |
|
product.insurance.excess.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.insurance.excess.currency (String) |
The ISO 4217 currency (for example, |
|
product.savings.aer (Number) |
The annual equivalent rate. Representats the interest rate if it was ompounded and paid. in one sum annualy. |
|
product.savings.minimumDeposit (Number) |
Minimum deposit value required to apply for the product. |
|
product.savings.maximumDeposit (Number) |
Maximum depoist value. |
|
product.savings.monthlyAccountFees (Number) |
Account fees of the product. |
|
product.savings.depositValue (Number) |
Amount deposited to create the account. |
|
product.mortage.interestRateType (String) |
The type of the interest rate. |
|
product.mortage.interestRate (Number) |
The interest rate in percent. |
|
product.mortage.bookingFee (Price) |
Fees upon booking. |
|
product.mortage.bookingFee.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.bookingFee.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.completionFee (Price) |
Fees payable upon full mortgage repayment. |
|
product.mortage.completionFee.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.completionFee.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.maxLoanToValue (Price) |
Maximum loan amount available as a percent of the property. |
|
product.mortage.maxLoanToValue.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.maxLoanToValue.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.deposit (Price) |
The deposit value. |
|
product.mortage.deposit.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.deposit.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.loanAmount (Price) |
The amount borrowed. |
|
product.mortage.loanAmount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.loanAmount.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.repaymentTerm (Number) |
The set repayment term in years. |
|
product.mortage.actualLoanToValue (Number) |
Value of the loan relative to the value of the property. |
|
product.mortage.baseSalary (Price) |
Annual base salary. |
|
product.mortage.baseSalary.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.baseSalary.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.expectedBonus (Price) |
Any additional expected salary that is not guaranteed. |
|
product.mortage.expectedBonus.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.expectedBonus.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.firstTimeBuyer (Boolean) |
Describes whether the visitor is a first time buyer. |
|
product.loan.loanValue (Price) |
The value of the loan taken. |
|
product.loan.loanValue.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.loanValue.currency (String) |
The ISO 4217 currency (for example, |
|
product.loan.startDate (Epochtimems) |
The start date of the loan. |
|
product.loan.endDate (Epochtimems) |
The end date of the loan. |
|
product.loan.loanTerm (Number) |
Duration of the repayment term in days. |
|
product.loan.paymentFrequency (String) |
The frequency of when the payments happen. |
|
product.loan.apr (Number) |
The annual percentage rate. |
|
product.loan.loanFees (Price) |
Fees payable during arrangement |
|
product.loan.loanFees.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.loanFees.currency (String) |
The ISO 4217 currency (for example, |
|
product.loan.completionFees (Price) |
Fees payable on completion |
|
product.loan.completionFees.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.completionFees.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.shareName (String) |
The name of the share. |
|
product.investment.sharePrice (Price) |
The price of the share. |
|
product.investment.sharePrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.sharePrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.openingPrice (Price) |
The opening price is the price at which a security first trades upon the opening of an exchange. |
|
product.investment.openingPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.openingPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.highPrice (Price) |
Today’s high is the highest price at which a stock traded during the course of the day. |
|
product.investment.highPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.highPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.lowPrice (Price) |
Today’s low is the lowest price at which a stock traded during the course of the day. |
|
product.investment.lowPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.lowPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.closePrice (Price) |
The final price at which a security is traded on in a previous trading day. |
|
product.investment.closePrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.closePrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.currency (String) |
The share currency. |
|
product.investment.symbol (String) |
The share symbol. |
|
product.investment.securityType (String) |
The security type of the share. |
|
product.investment.exchange (String) |
The location where the product is being traded. |
|
product.investment.fundType (String) |
The type of the fund. |
|
product.investment.fundManager (String) |
The manager of the fund. |
|
product.investment.launchDate (Epochtimems) |
The launch date of the fund. |
|
product.investment.fundSize (Price) |
The size of the fund. |
|
product.investment.fundSize.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.fundSize.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.holdingsAmount (Number) |
The amount of holdings. |
|
product.productId (String) |
ID uniquely identifying the finance product. |
|
product.price (Price) |
The price of the product after discounts. |
|
product.price.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.price.currency (String) |
The ISO 4217 currency (for example, |
|
product.originalPrice (Price) |
The original price of the product. |
|
product.originalPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.originalPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.onSale (Boolean) |
Is item on sale? |
|
product.categories (String[]) |
A list of one or more product categories this product belongs to. Each category is a full path of a category where each level is separated by ' > '. |
|
quantity (Number) |
The number of products described by the line item. |
|
subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
discount (Price) |
The amount discounted from vouchers or promotions for the product. |
|
discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
discount.currency (String) |
The ISO 4217 currency (for example, |
|
subtotalIncludingTax (Price) |
The price of the item including tax, excluding discounts. |
|
subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
transaction.id (String) |
An Id unique to the transaction |
|
transaction.firstTransaction (Boolean) |
True only if this is the first ever transaction for the user |
|
transaction.paymentType (String) |
The type of payment |
|
transaction.billingAddress.addressee (String) |
Full name of the person for whom the address is for |
|
transaction.billingAddress.company (String) |
The name of the company |
|
transaction.billingAddress.lines (String[]) |
An array of address lines NOT including city, region, postcode or country (maximum of 3 lines allowed) |
|
transaction.billingAddress.locality (String) |
The town or city |
|
transaction.billingAddress.region (String) |
E.g state in the US, county in the UK |
|
transaction.billingAddress.postalCode (String) |
Can be the country equivalent code (for example, zip code for the U.S) |
|
transaction.billingAddress.country (String) |
The name of the country |
|
transaction.billingAddress.countryCode (String) |
An ISO 3166-1 alpha-2 country code |
|
transaction.parentId (String) |
If the transaction is an amendment to a previous transaction, should be the Id of the parent transaction |
|
Example JavaScript
uv.emit('fiBasketItemTransaction', {
basket: {
id: 'BASK123',
subtotal: {
value: 9.99,
currency: 'USD'
},
total: {
value: 9.99,
currency: 'USD'
},
quantity: 10,
discount: {
value: 9.99,
currency: 'USD'
},
tax: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
}
},
product: {
name: 'Finance product A',
category: [
'Car Insurance',
'European cover'
],
productType: 'loan',
insurance: {
coverDuration: 210,
paymentFrequency: 'annual',
excess: {
value: 9.99,
currency: 'USD'
}
},
savings: {
aer: 1.25,
minimumDeposit: 1000,
maximumDeposit: 100000,
monthlyAccountFees: 5,
depositValue: 2000
},
mortage: {
interestRateType: 'variable',
interestRate: 4.79,
bookingFee: {
value: 9.99,
currency: 'USD'
},
completionFee: {
value: 9.99,
currency: 'USD'
},
maxLoanToValue: {
value: 9.99,
currency: 'USD'
},
deposit: {
value: 9.99,
currency: 'USD'
},
loanAmount: {
value: 9.99,
currency: 'USD'
},
repaymentTerm: 25,
actualLoanToValue: null,
baseSalary: {
value: 9.99,
currency: 'USD'
},
expectedBonus: {
value: 9.99,
currency: 'USD'
},
firstTimeBuyer: null
},
loan: {
loanValue: {
value: 9.99,
currency: 'USD'
},
startDate: 1461236327,
endDate: 1461236361,
loanTerm: 1325,
paymentFrequency: 'monthly',
apr: 4.5,
loanFees: {
value: 9.99,
currency: 'USD'
},
completionFees: {
value: 9.99,
currency: 'USD'
}
},
investment: {
shareName: 'BT',
sharePrice: {
value: 9.99,
currency: 'USD'
},
openingPrice: {
value: 9.99,
currency: 'USD'
},
highPrice: {
value: 9.99,
currency: 'USD'
},
lowPrice: {
value: 9.99,
currency: 'USD'
},
closePrice: {
value: 9.99,
currency: 'USD'
},
currency: 'USD',
symbol: 'BEL20',
securityType: 'index',
exchange: 'Brussels',
fundType: 'UCITS',
fundManager: 'Paul Gibson',
launchDate: 1461236327,
fundSize: {
value: 9.99,
currency: 'USD'
},
holdingsAmount: 50
},
productId: 'abc123',
price: {
value: 9.99,
currency: 'USD'
},
originalPrice: {
value: 9.99,
currency: 'USD'
},
onSale: null,
categories: [
'Car insurance > European cover',
'Special offers'
]
},
quantity: 2,
subtotal: {
value: 9.99,
currency: 'USD'
},
discount: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
},
transaction: {
id: '83748372',
firstTransaction: true,
paymentType: 'paypal',
billingAddress: {
addressee: 'John Smith',
company: 'Amce Inc',
lines: [
'Flat 12',
'123 High Street'
],
locality: 'London',
region: 'New York',
postalCode: '10010',
country: 'United States',
countryCode: 'US'
},
parentId: '83748371'
}
})fiBasketSummary
Optional
Emitted for each time the basket is visible to the visitor either as an inline minibasket or in a view that shows only the basket. If the visitor’s basket is changed in any way, the summary is emitted again.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
basket.id (String) |
Should be an ID unique to the basket. |
|
basket.subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
basket.subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
basket.total (Price) |
The total cost of the basket including tax and discounts. |
|
basket.total.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.total.currency (String) |
The ISO 4217 currency (for example, |
|
basket.quantity (Number) |
The number of items in the basket. |
|
basket.discount (Price) |
The amount discounted from vouchers or promotions. |
|
basket.discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.discount.currency (String) |
The ISO 4217 currency (for example, |
|
basket.tax (Price) |
The total tax for the basket. |
|
basket.tax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.tax.currency (String) |
The ISO 4217 currency (for example, |
|
basket.subtotalIncludingTax (Price) |
The total cost of the basket including tax, excluding discounts. |
|
basket.subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
Example JavaScript
uv.emit('fiBasketSummary', {
basket: {
id: 'BASK123',
subtotal: {
value: 9.99,
currency: 'USD'
},
total: {
value: 9.99,
currency: 'USD'
},
quantity: 10,
discount: {
value: 9.99,
currency: 'USD'
},
tax: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
}
}
})fiError
Optional
Emitted for every error.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
code (String) |
The error code. |
|
message (String) |
The error message. |
|
Example JavaScript
uv.emit('fiError', {
code: null,
message: null
})fiFilterCriteria
Optional
Emitted once or more on listing and search result views in order to report the filters applied and the sorting.
On search views, the event is emitted with the name search, operator equal and value as the search query.
On category views, for each category the view falls under, the event is emitted with the name category, operator equal and value the category name for each category.
Ranges are modeled by emitting the upper and lower bound as separate filter criteria events, setting the operator as greater than or less than.
When visitors add, remove or change a filter, a new view event is emitted followed by all FilterCriteria that are still active after the change.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
summary.pagination (Number) |
The number of items shown per page to the visitor. |
|
summary.resultCount (Number) |
The number of items that match the current query and/or filters. Should be more than or equal to the number of items shown to the visitor. |
|
summary.layout (String) |
The user’s chosen visual layout of the listing (for example, |
|
summary.sortBy (String) |
The sort column. |
|
summary.sortDirection (String) |
The sort direction, that is, |
|
name (String) |
The name of criteria (for example, |
|
operator (String) |
Can be |
|
value.boolean (Boolean) |
Should only be populated if the type is 'Boolean'. |
|
value.integer (String) |
Should only be populated if the type is 'Integer'. |
|
value.long (Long) |
Should only be populated if the type is 'Long'. |
|
value.float (Number) |
Should only be populated if the type is 'Float'. |
|
value.timestamp (Epochtimems) |
Should only be populated if the type is 'EpochTimeMs'. |
|
value.money (Number) |
Should only be populated if the type is 'Money'. |
|
value.currency (String) |
Should only be populated if the type is 'Currency'. |
|
value.email (String) |
Should only be populated if the type is 'Email'. |
|
value.url (String) |
Should only be populated if the type is 'URL'. |
|
value.string (String) |
Should only be populated if the type is 'String'. |
|
value.text (String) |
Should only be populated if the type is 'Text'. |
|
value.date (Date) |
Should only be populated if the type is 'Date'. |
|
value.json (Json) |
Should only be populated if the type is 'JSON'. |
|
Example JavaScript
uv.emit('fiFilterCriteria', {
summary: {
pagination: 1,
resultCount: 20,
layout: 'list',
sortBy: 'price',
sortDirection: 'descending'
},
name: 'price',
operator: 'less than',
value: {
'boolean': true,
integer: '10',
'long': 1238902625,
'float': 5.5,
timestamp: 1455748626070,
money: 9.99,
currency: 'USD',
email: 'john.smith@gmail.com',
url: 'http://demo.qubitproducts.com',
string: 'This is some text',
text: 'This is some longer text',
date: '2016-05-20T17:33:45+00:00',
json: '{"key":"value","anotherKey":123,"yetAnotherKey":{"subKey":true}}'
}
})fiFormSubmission
Optional
Should be emitted when a user submits a form.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
submissionId (String) |
An ID unique to the form submission. |
|
name (String) |
The name of the form. |
|
Example JavaScript
uv.emit('fiFormSubmission', {
submissionId: null,
name: 'ContactUsEnquiry'
})fiInteraction
Optional
Emitted to track visitor interaction for certain elements on the page. These events are not emitted for all interactions on all elements, only those that are of interest.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
type (String) |
The interaction type (for example, click, view, hover, download, share) |
|
name (String) |
A meaningful name unique to the event. |
|
Example JavaScript
uv.emit('fiInteraction', {
type: 'click',
name: 'TopNavHomeButton'
})fiProduct
Optional
Emitted when a product is shown or rendered into a view or page.
All product instances should result in a Product event, whether the main focus of the page or as part of a listing.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
product.name (String) |
The product name. |
|
product.category (String[]) |
An array of categories, highest level first, defining the product. Recommended to not excede 4 items long. |
|
product.productType (String) |
The type of the product |
|
product.insurance.coverDuration (Number) |
The duration of the cover, in days. |
|
product.insurance.paymentFrequency (String) |
The frequency of when the payments happen. |
|
product.insurance.excess (Price) |
The excess required. |
|
product.insurance.excess.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.insurance.excess.currency (String) |
The ISO 4217 currency (for example, |
|
product.savings.aer (Number) |
The annual equivalent rate. Representats the interest rate if it was ompounded and paid. in one sum annualy. |
|
product.savings.minimumDeposit (Number) |
Minimum deposit value required to apply for the product. |
|
product.savings.maximumDeposit (Number) |
Maximum depoist value. |
|
product.savings.monthlyAccountFees (Number) |
Account fees of the product. |
|
product.savings.depositValue (Number) |
Amount deposited to create the account. |
|
product.mortage.interestRateType (String) |
The type of the interest rate. |
|
product.mortage.interestRate (Number) |
The interest rate in percent. |
|
product.mortage.bookingFee (Price) |
Fees upon booking. |
|
product.mortage.bookingFee.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.bookingFee.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.completionFee (Price) |
Fees payable upon full mortgage repayment. |
|
product.mortage.completionFee.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.completionFee.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.maxLoanToValue (Price) |
Maximum loan amount available as a percent of the property. |
|
product.mortage.maxLoanToValue.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.maxLoanToValue.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.deposit (Price) |
The deposit value. |
|
product.mortage.deposit.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.deposit.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.loanAmount (Price) |
The amount borrowed. |
|
product.mortage.loanAmount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.loanAmount.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.repaymentTerm (Number) |
The set repayment term in years. |
|
product.mortage.actualLoanToValue (Number) |
Value of the loan relative to the value of the property. |
|
product.mortage.baseSalary (Price) |
Annual base salary. |
|
product.mortage.baseSalary.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.baseSalary.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.expectedBonus (Price) |
Any additional expected salary that is not guaranteed. |
|
product.mortage.expectedBonus.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.mortage.expectedBonus.currency (String) |
The ISO 4217 currency (for example, |
|
product.mortage.firstTimeBuyer (Boolean) |
Describes whether the visitor is a first time buyer. |
|
product.loan.loanValue (Price) |
The value of the loan taken. |
|
product.loan.loanValue.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.loanValue.currency (String) |
The ISO 4217 currency (for example, |
|
product.loan.startDate (Epochtimems) |
The start date of the loan. |
|
product.loan.endDate (Epochtimems) |
The end date of the loan. |
|
product.loan.loanTerm (Number) |
Duration of the repayment term in days. |
|
product.loan.paymentFrequency (String) |
The frequency of when the payments happen. |
|
product.loan.apr (Number) |
The annual percentage rate. |
|
product.loan.loanFees (Price) |
Fees payable during arrangement |
|
product.loan.loanFees.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.loanFees.currency (String) |
The ISO 4217 currency (for example, |
|
product.loan.completionFees (Price) |
Fees payable on completion |
|
product.loan.completionFees.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.loan.completionFees.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.shareName (String) |
The name of the share. |
|
product.investment.sharePrice (Price) |
The price of the share. |
|
product.investment.sharePrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.sharePrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.openingPrice (Price) |
The opening price is the price at which a security first trades upon the opening of an exchange. |
|
product.investment.openingPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.openingPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.highPrice (Price) |
Today’s high is the highest price at which a stock traded during the course of the day. |
|
product.investment.highPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.highPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.lowPrice (Price) |
Today’s low is the lowest price at which a stock traded during the course of the day. |
|
product.investment.lowPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.lowPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.closePrice (Price) |
The final price at which a security is traded on in a previous trading day. |
|
product.investment.closePrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.closePrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.currency (String) |
The share currency. |
|
product.investment.symbol (String) |
The share symbol. |
|
product.investment.securityType (String) |
The security type of the share. |
|
product.investment.exchange (String) |
The location where the product is being traded. |
|
product.investment.fundType (String) |
The type of the fund. |
|
product.investment.fundManager (String) |
The manager of the fund. |
|
product.investment.launchDate (Epochtimems) |
The launch date of the fund. |
|
product.investment.fundSize (Price) |
The size of the fund. |
|
product.investment.fundSize.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.investment.fundSize.currency (String) |
The ISO 4217 currency (for example, |
|
product.investment.holdingsAmount (Number) |
The amount of holdings. |
|
product.productId (String) |
ID uniquely identifying the finance product. |
|
product.price (Price) |
The price of the product after discounts. |
|
product.price.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.price.currency (String) |
The ISO 4217 currency (for example, |
|
product.originalPrice (Price) |
The original price of the product. |
|
product.originalPrice.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
product.originalPrice.currency (String) |
The ISO 4217 currency (for example, |
|
product.onSale (Boolean) |
Is item on sale? |
|
product.categories (String[]) |
A list of one or more product categories this product belongs to. Each category is a full path of a category where each level is separated by ' > '. |
|
eventType (String) |
The type of product event (for example, 'listing' or 'detail') |
|
index (Number) |
The index of the product as it’s positioned on the page (for example, the first product in a listing would be 0, the next would be 1). |
|
Example JavaScript
uv.emit('fiProduct', {
product: {
name: 'Finance product A',
category: [
'Car Insurance',
'European cover'
],
productType: 'loan',
insurance: {
coverDuration: 210,
paymentFrequency: 'annual',
excess: {
value: 9.99,
currency: 'USD'
}
},
savings: {
aer: 1.25,
minimumDeposit: 1000,
maximumDeposit: 100000,
monthlyAccountFees: 5,
depositValue: 2000
},
mortage: {
interestRateType: 'variable',
interestRate: 4.79,
bookingFee: {
value: 9.99,
currency: 'USD'
},
completionFee: {
value: 9.99,
currency: 'USD'
},
maxLoanToValue: {
value: 9.99,
currency: 'USD'
},
deposit: {
value: 9.99,
currency: 'USD'
},
loanAmount: {
value: 9.99,
currency: 'USD'
},
repaymentTerm: 25,
actualLoanToValue: null,
baseSalary: {
value: 9.99,
currency: 'USD'
},
expectedBonus: {
value: 9.99,
currency: 'USD'
},
firstTimeBuyer: null
},
loan: {
loanValue: {
value: 9.99,
currency: 'USD'
},
startDate: 1461236327,
endDate: 1461236361,
loanTerm: 1325,
paymentFrequency: 'monthly',
apr: 4.5,
loanFees: {
value: 9.99,
currency: 'USD'
},
completionFees: {
value: 9.99,
currency: 'USD'
}
},
investment: {
shareName: 'BT',
sharePrice: {
value: 9.99,
currency: 'USD'
},
openingPrice: {
value: 9.99,
currency: 'USD'
},
highPrice: {
value: 9.99,
currency: 'USD'
},
lowPrice: {
value: 9.99,
currency: 'USD'
},
closePrice: {
value: 9.99,
currency: 'USD'
},
currency: 'USD',
symbol: 'BEL20',
securityType: 'index',
exchange: 'Brussels',
fundType: 'UCITS',
fundManager: 'Paul Gibson',
launchDate: 1461236327,
fundSize: {
value: 9.99,
currency: 'USD'
},
holdingsAmount: 50
},
productId: 'abc123',
price: {
value: 9.99,
currency: 'USD'
},
originalPrice: {
value: 9.99,
currency: 'USD'
},
onSale: null,
categories: [
'Car insurance > European cover',
'Special offers'
]
},
eventType: 'detail',
index: 1
})fiUserLogin
Optional
Emitted when a user logs in.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
user.id (String) |
A unique user Id. Can also be a hash of the username and/or email address |
|
user.title (String) |
The user’s title |
|
user.firstName (String) |
The user’s first name |
|
user.lastName (String) |
The user’s last name |
|
user.gender (String) |
The user’s gender. Can be |
|
user.username (String) |
The username for the user |
|
user.email (String) |
The user’s primary email address |
|
user.firstSession (Boolean) |
True if it’s the user’s first session |
|
user.hasTransacted (Boolean) |
True if the user has completed 1 or more transactions |
|
user.loyalty.id (String) |
Loyalty program membership number |
|
user.loyalty.tier (String) |
The level of the loyalty program this user holds |
|
user.loyalty.tierPoints (Number) |
The number of tier points |
|
user.loyalty.membershipType (String) |
The type of loyalty membership |
|
user.loyalty.membershipPoints (Number) |
The number of points from this membership |
|
user.address.addressee (String) |
Full name of the person for whom the address is for |
|
user.address.company (String) |
The name of the company |
|
user.address.lines (String[]) |
An array of address lines NOT including city, region, postcode or country (maximum of 3 lines allowed) |
|
user.address.locality (String) |
The town or city |
|
user.address.region (String) |
E.g state in the US, county in the UK |
|
user.address.postalCode (String) |
Can be the country equivalent code (for example, zip code for the U.S) |
|
user.address.country (String) |
The name of the country |
|
user.address.countryCode (String) |
An ISO 3166-1 alpha-2 country code |
|
user.isGuest (String) |
True if the user is a guest user without a registered account |
|
user.age (Number) |
The user’s age in years |
|
user.phoneNumber (String) |
The user’s phone number. Should be formatted without spaces, braces, or hyphens |
|
user.countryCallingCode (String) |
The country calling code for the given phone number, formatted to include the |
|
user.device (String) |
Device the user is browsing on - for example |
|
user.phone (String) |
The user’s phone number. |
|
user.dateOfBirth (String) |
The user’s date of birth. |
|
firstLogin (Boolean) |
True only if this is the first time the user has logged in. |
|
Example JavaScript
uv.emit('fiUserLogin', {
user: {
id: '2861102bace6e6620948564f0ce0a7cd',
title: 'Mr',
firstName: 'John',
lastName: 'Smith',
gender: 'Male',
username: 'JohnSmith',
email: 'john@johnsmith.com',
firstSession: null,
hasTransacted: true,
loyalty: {
id: '8989752-223',
tier: 'silver',
tierPoints: null,
membershipType: 'Clearsky Rewards',
membershipPoints: null
},
address: {
addressee: 'John Smith',
company: 'Amce Inc',
lines: [
'Flat 12',
'123 High Street'
],
locality: 'London',
region: 'New York',
postalCode: '10010',
country: 'United States',
countryCode: 'US'
},
isGuest: 'true',
age: 42,
phoneNumber: '2121234567',
countryCallingCode: '1',
device: 'kiosk',
phone: '555-555-5555',
dateOfBirth: '12/31/1982'
},
firstLogin: true
})fiUserSignup
Optional
Emitted when a user signs up for a newsletter or event, for example.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
user.id (String) |
A unique user Id. Can also be a hash of the username and/or email address |
|
user.title (String) |
The user’s title |
|
user.firstName (String) |
The user’s first name |
|
user.lastName (String) |
The user’s last name |
|
user.gender (String) |
The user’s gender. Can be |
|
user.username (String) |
The username for the user |
|
user.email (String) |
The user’s primary email address |
|
user.firstSession (Boolean) |
True if it’s the user’s first session |
|
user.hasTransacted (Boolean) |
True if the user has completed 1 or more transactions |
|
user.loyalty.id (String) |
Loyalty program membership number |
|
user.loyalty.tier (String) |
The level of the loyalty program this user holds |
|
user.loyalty.tierPoints (Number) |
The number of tier points |
|
user.loyalty.membershipType (String) |
The type of loyalty membership |
|
user.loyalty.membershipPoints (Number) |
The number of points from this membership |
|
user.address.addressee (String) |
Full name of the person for whom the address is for |
|
user.address.company (String) |
The name of the company |
|
user.address.lines (String[]) |
An array of address lines NOT including city, region, postcode or country (maximum of 3 lines allowed) |
|
user.address.locality (String) |
The town or city |
|
user.address.region (String) |
E.g state in the US, county in the UK |
|
user.address.postalCode (String) |
Can be the country equivalent code (for example, zip code for the U.S) |
|
user.address.country (String) |
The name of the country |
|
user.address.countryCode (String) |
An ISO 3166-1 alpha-2 country code |
|
user.isGuest (String) |
True if the user is a guest user without a registered account |
|
user.age (Number) |
The user’s age in years |
|
user.phoneNumber (String) |
The user’s phone number. Should be formatted without spaces, braces, or hyphens |
|
user.countryCallingCode (String) |
The country calling code for the given phone number, formatted to include the |
|
user.device (String) |
Device the user is browsing on - for example |
|
user.phone (String) |
The user’s phone number. |
|
user.dateOfBirth (String) |
The user’s date of birth. |
|
type (String) |
The type of sign up (for example, newsletter or event) |
|
name (String) |
A meaningful name unique to the sign up. |
|
Example JavaScript
uv.emit('fiUserSignup', {
user: {
id: '2861102bace6e6620948564f0ce0a7cd',
title: 'Mr',
firstName: 'John',
lastName: 'Smith',
gender: 'Male',
username: 'JohnSmith',
email: 'john@johnsmith.com',
firstSession: null,
hasTransacted: true,
loyalty: {
id: '8989752-223',
tier: 'silver',
tierPoints: null,
membershipType: 'Clearsky Rewards',
membershipPoints: null
},
address: {
addressee: 'John Smith',
company: 'Amce Inc',
lines: [
'Flat 12',
'123 High Street'
],
locality: 'London',
region: 'New York',
postalCode: '10010',
country: 'United States',
countryCode: 'US'
},
isGuest: 'true',
age: 42,
phoneNumber: '2121234567',
countryCallingCode: '1',
device: 'kiosk',
phone: '555-555-5555',
dateOfBirth: '12/31/1982'
},
type: 'newsletter',
name: 'loyaltyaccount'
})fiVoucher
Optional
Emitted when a voucher code is entered.
Example schema
| Field (JS Data Type) | Description | Required for |
|---|---|---|
entry (String) |
Actual voucher code the user enters. |
|
entrySuccess (Boolean) |
Whether or not the voucher is successfully applied to the transaction. An entry must be valid to be successful. |
|
voucher.id (String) |
A unique Id to identify the voucher used, which should be the same for all visitors that are using the voucher/promotion |
|
voucher.label (String) |
A name or label for the voucher/promotion |
|
transaction.id (String) |
An Id unique to the transaction |
|
transaction.firstTransaction (Boolean) |
True only if this is the first ever transaction for the user |
|
transaction.paymentType (String) |
The type of payment |
|
transaction.billingAddress.addressee (String) |
Full name of the person for whom the address is for |
|
transaction.billingAddress.company (String) |
The name of the company |
|
transaction.billingAddress.lines (String[]) |
An array of address lines NOT including city, region, postcode or country (maximum of 3 lines allowed) |
|
transaction.billingAddress.locality (String) |
The town or city |
|
transaction.billingAddress.region (String) |
E.g state in the US, county in the UK |
|
transaction.billingAddress.postalCode (String) |
Can be the country equivalent code (for example, zip code for the U.S) |
|
transaction.billingAddress.country (String) |
The name of the country |
|
transaction.billingAddress.countryCode (String) |
An ISO 3166-1 alpha-2 country code |
|
transaction.parentId (String) |
If the transaction is an amendment to a previous transaction, should be the Id of the parent transaction |
|
basket.id (String) |
Should be an ID unique to the basket. |
|
basket.subtotal (Price) |
The total cost of the basket excluding tax and discounts. |
|
basket.subtotal.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotal.currency (String) |
The ISO 4217 currency (for example, |
|
basket.total (Price) |
The total cost of the basket including tax and discounts. |
|
basket.total.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.total.currency (String) |
The ISO 4217 currency (for example, |
|
basket.quantity (Number) |
The number of items in the basket. |
|
basket.discount (Price) |
The amount discounted from vouchers or promotions. |
|
basket.discount.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.discount.currency (String) |
The ISO 4217 currency (for example, |
|
basket.tax (Price) |
The total tax for the basket. |
|
basket.tax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.tax.currency (String) |
The ISO 4217 currency (for example, |
|
basket.subtotalIncludingTax (Price) |
The total cost of the basket including tax, excluding discounts. |
|
basket.subtotalIncludingTax.value (Number) |
Depending on the context, this could be the value of the basket, product, package, total, subtotal, discount, shipping, item, game, bet, etc. Refer to our setup docs for more specific details for each vertical and event |
|
basket.subtotalIncludingTax.currency (String) |
The ISO 4217 currency (for example, |
|
Example JavaScript
uv.emit('fiVoucher', {
entry: '12321',
entrySuccess: true,
voucher: {
id: 'AO8734',
label: 'SummerPromo'
},
transaction: {
id: '83748372',
firstTransaction: true,
paymentType: 'paypal',
billingAddress: {
addressee: 'John Smith',
company: 'Amce Inc',
lines: [
'Flat 12',
'123 High Street'
],
locality: 'London',
region: 'New York',
postalCode: '10010',
country: 'United States',
countryCode: 'US'
},
parentId: '83748371'
},
basket: {
id: 'BASK123',
subtotal: {
value: 9.99,
currency: 'USD'
},
total: {
value: 9.99,
currency: 'USD'
},
quantity: 10,
discount: {
value: 9.99,
currency: 'USD'
},
tax: {
value: 9.99,
currency: 'USD'
},
subtotalIncludingTax: {
value: 9.99,
currency: 'USD'
}
}
})
Very useful
Not really
Very useful
Not really