Standard User Event
Required data to get started with Opti-X
A real-time feed of data describing customer activity. Some events may need to be sourced from multiple systems. The events should include customer account and banking activity such as registrations, logins, deposits, and withdrawals.
The data tables and fields described in this document represent an ideal data structure for using Opti-X. If your data does not include everything presented here, alternative methods exist based on the available data.
Page Visit (Mandatory event)
Recording when a user views a specific page on a platform or website.
This is a basic event set in Optimove's platform, and has mandatory parameters.
Event setup:
Event Key | Event Name | Type |
---|---|---|
set_page_visit | Page Visit | Simple event |
Event's Parameters:
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
customURL | Custom URL | String | Mandatory |
pageTitle | Page Title | string | Mandatory |
category | Page Category | string | NOT Mandatory |
Registration
Capturing the process of users creating new accounts on a platform or service.
Event setup:
Event Key | Event Name | Type |
---|---|---|
core_registration | Core Registration | Simple event |
Recommended parameters for registration event:
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
String | Mandatory in case you want to send an email after registration | ||
first_name | First Name | string | It can be used for personalization tags |
Login
Tracking instances when users log into their accounts on a platform.
Event setup:
Event Key | Event Name | Type |
---|---|---|
core_login | Core Login | Simple event |
Recommended parameters for Login event:
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
login_timestamp | Login timestamp | String | ISO 8601 datetime of login |
balance | Balance | Number | |
is_first_login | Is First Login | Boolean | Is the first time they have logged in? |
session_ref | Game Session Reference | String | |
ccy_code | CCY Code | String | |
language | Language | String | |
country | Country | String | |
platform | Platform | String | |
channel | Channel | String | |
skinid | Skin ID | String | |
license | License | String |
Deposit
Recording when a user makes a deposit attempt in their account.
Event setup:
Event Key | Event Name | Type |
---|---|---|
core_deposit | Core Deposit | Simple event |
Recommended parameters for deposit event:
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
deposit_timestamp | Deposit timestamp | String | ISO 8601 datetime of deposit |
start_balance | Start Balance | Number | |
deposit_amount | Deposit Amount | Number | |
deposit_method | Deposit Method | String | |
deposit_status | Deposit Status | String | |
ccy_code | CCY Code | String | |
language | Language | String | |
country | Country | String | |
platform | Platform | String | |
channel | Channel | String | |
skinid | Skin ID | String | |
license | License | String |
Withdrawal
Recording when a user withdraws funds or removes money from their account.
Event setup:
Event Key | Event Name | Type |
---|---|---|
core_withdrawal | Core Withdrawal | Simple event |
Recommended parameters for withdrawal event:
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
withdrawal_timestamp | Withdrawal request timestamp | String | ISO 8601 datetime of withdrawal |
start_balance | Start Balance | Number | |
withdrawal_amount | Withdrawal Amount | Number | |
withdrawal_method | Withdrawal Method | String | |
withdrawal_status | Withdrawal Status | String | Optional |
ccy_code | CCY Code | String | |
language | Language | String | |
country | Country | String | |
platform | Platform | String | |
channel | Channel | String | |
skinid | Skin ID | String | |
license | License | String |
Withdrawal Cancellation
Capturing instances where a withdrawal process is initiated but cancelled before completion.
Event setup:
Event Key | Event Name | Type |
---|---|---|
core_withdrawal_cancellation | Core Withdrawal Cancellation | Simple event |
Recommended parameters for withdrawal cancellation event:
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
event_name | Event name | String | core_withdrawal_cancellation |
withdrawal_cancel_timestamp | Withdrawal cancellation timestamp | String | ISO 8601 datetime of withdrawal cancellation |
end_balance | End Balance | Number | Balance after cancellation |
withdrawal_amount | Withdrawal Amount | Number | |
withdrawal_method | Withdrawal Method | String | |
withdrawal_status | Withdrawal Status | String | Optional |
ccy_code | CCY Code | String | |
language | Language | String | |
country | Country | String | |
platform | Platform | String | |
channel | Channel | String | |
skinid | Skin ID | String | |
license | License | String |
Updated 2 months ago