Different Types of Events
The mentioned events, each designed with unique functionalities and specific properties, are passed as objects in the messageBody for individual event captures, ensuring effective analytics.
PING: It's a periodic event triggered every 15 seconds while the user is on a page.
| PARAMETERS | DATATYPE | DESCRIPTION | TYPE |
|---|---|---|---|
clientId | string | The unique clientId is found on the dashboard. | REQUIRED |
eventType | string | PING | REQUIRED |
eventLocation | string | PAGE / PAYWALL / CONTENT_FLOW_LOGIN / CONTENT_FLOW_OTP / CONTENT_FLOW_ADD_MONEY_PAGE / CONTENT_FLOW_PAYMENT_GATEWAY / SSO_LOGIN / SSO_OTP / UDB / UDB_LOGIN / UDB_OTP / SUBS_LOGIN / SUBS_OTP / POPUP / SLP / SAP / SRP / SUBS_PAYMENT_GATEWAY / FAV / FAV_ICON / USER_BAR / RECOMMENDATION_POPUP | REQUIRED |
anonId | uuid | A unique anonymous ID for each user. | REQUIRED |
pingId | uuid | A unique pingId for each session. | REQUIRED |
active | int8 | 0 when the user is out of focus. 1 when the user is in focus. | REQUIRED |
userId | string | A unique user ID for each user if he/she/they is logged in | OPTIONAL |
CLICK: It's an event triggered when the user clicks a subject of interest.
| PARAMETERS | DATATYPE | DESCRIPTION | TYPE |
|---|---|---|---|
clientId | string | The unique clientId is found on the dashboard. | REQUIRED |
eventType | string | CLICK | REQUIRED |
eventLocation | string | PAGE / PAYWALL / CONTENT_FLOW_LOGIN / CONTENT_FLOW_OTP / CONTENT_FLOW_ADD_MONEY_PAGE / CONTENT_FLOW_PAYMENT_GATEWAY / SSO_LOGIN / SSO_OTP / UDB / UDB_LOGIN / UDB_OTP / SUBS_LOGIN / SUBS_OTP / POPUP / SLP / SAP / SRP / SUBS_PAYMENT_GATEWAY / FAV / FAV_ICON / USER_BAR / RECOMMENDATION_POPUP | REQUIRED |
anonId | uuid | A unique anonymous ID for each user. | REQUIRED |
userId | string | A unique user ID for each user if he/she is logged in | OPTIONAL |
clickAction | string | P2P / ADD_MONEY_TO_WALLET / PAYMENT_GATEWAY_CROSS_BTN / LOGIN_FLOW_CROSSBTN / CONTENT / PASS / SUBS / MOBILE / EMAIL / GOOGLE / FACEBOOK / BUY_NOW / RENEW_BTN / CHANGE_PLAN / ADD_ADDRESS / COUPON / POPUP_REDIRECT / POPUP_CLOSE | OPTIONAL |
EXIT: It's an event triggered when the user exits.
| PARAMETERS | DATATYPE | DESCRIPTION | TYPE |
|---|---|---|---|
clientId | string | The unique clientId is found on the dashboard. | REDUIRED |
eventType | string | EXIT | REDUIRED |
eventLocation | string | PAGE / PAYWALL / CONTENT_FLOW_LOGIN / CONTENT_FLOW_OTP / CONTENT_FLOW_ADD_MONEY_PAGE / CONTENT_FLOW_PAYMENT_GATEWAY / SSO_LOGIN / SSO_OTP / UDB / UDB_LOGIN / UDB_OTP / SUBS_LOGIN / SUBS_OTP / POPUP / SLP / SAP / SRP / SUBS_PAYMENT_GATEWAY / FAV / FAV_ICON / USER_BAR / RECOMMENDATION_POPUP | REDUIRED |
anonId | uuid | A unique anonymous ID for each user. | REDUIRED |
userId | string | A unique user ID for each user if he/she is logged in | OPTIONAL |
PURCHASE: It's an event triggered when the user makes a purchase.
| PARAMETERS | DATATYPE | DESCRIPTION | TYPE |
|---|---|---|---|
clientId | string | The unique clientId is found on the dashboard. | REQUIRED |
eventType | string | PURCHASE | REQUIRED |
eventLocation | string | PAGE / PAYWALL / CONTENT_FLOW_LOGIN / CONTENT_FLOW_OTP / CONTENT_FLOW_ADD_MONEY_PAGE / CONTENT_FLOW_PAYMENT_GATEWAY / SSO_LOGIN / SSO_OTP / UDB / UDB_LOGIN / UDB_OTP / SUBS_LOGIN / SUBS_OTP / POPUP / SLP / SAP / SRP / SUBS_PAYMENT_GATEWAY / FAV / FAV_ICON / USER_BAR / RECOMMENDATION_POPUP | REQUIRED |
anonId | uuid | A unique anonymous ID for each user. | REQUIRED |
userId | string | A unique user ID for each user if he/she is logged in | REQUIRED |
purchaseId | A unique ID of the order after making a purchase. | REQUIRED | |
TRANSACTION: It's an event triggered when the user makes a transaction.
| PARAMETERS | DATATYPE | DESCRIPTION | TYPE |
|---|---|---|---|
clientId | string | The unique clientId is found on the dashboard. | REQUIRED |
eventType | string | TRANSACTION | REQUIRED |
eventLocation | string | PAGE / PAYWALL / CONTENT_FLOW_LOGIN / CONTENT_FLOW_OTP / CONTENT_FLOW_ADD_MONEY_PAGE / CONTENT_FLOW_PAYMENT_GATEWAY / SSO_LOGIN / SSO_OTP / UDB / UDB_LOGIN / UDB_OTP / SUBS_LOGIN / SUBS_OTP / POPUP / SLP / SAP / SRP / SUBS_PAYMENT_GATEWAY / FAV / FAV_ICON / USER_BAR / RECOMMENDATION_POPUP | REQUIRED |
anonId | uuid | A unique anonymous ID for each user. | REQUIRED |
userId | string | A unique user ID for each user if he/she is logged in | REQUIRED |
transactionId | A unique ID of the order after making a transaction. | REQUIRED | |
REGISTRATION:
| PARAMETERS | DATATYPE | VALIDATION | TYPE |
|---|---|---|---|
clientId | string | The unique clientId is found on the dashboard. | REQUIRED |
eventType | string | REGISTRATION | REQUIRED |
eventLocation | string | PAGE / PAYWALL / CONTENT_FLOW_LOGIN / CONTENT_FLOW_OTP / CONTENT_FLOW_ADD_MONEY_PAGE / CONTENT_FLOW_PAYMENT_GATEWAY / SSO_LOGIN / SSO_OTP / UDB / UDB_LOGIN / UDB_OTP / SUBS_LOGIN / SUBS_OTP / POPUP / SLP / SAP / SRP / SUBS_PAYMENT_GATEWAY / FAV / FAV_ICON / USER_BAR / RECOMMENDATION_POPUP | REQUIRED |
anonId | uuid | A unique anonymous ID for each user. | REQUIRED |
userId | string | A unique ID of the order after making a transaction. | REQUIRED |
VALIDATION:
| PARAMETERS | DATATYPE | DESCRIPTION | TYPE |
|---|---|---|---|
clientId | string | The unique clientId is found on the dashboard. | REQUIRED |
eventType | string | VALIDATION | REQUIRED |
eventLocation | string | PAGE / PAYWALL / CONTENT_FLOW_LOGIN / CONTENT_FLOW_OTP / CONTENT_FLOW_ADD_MONEY_PAGE / CONTENT_FLOW_PAYMENT_GATEWAY / SSO_LOGIN / SSO_OTP / UDB / UDB_LOGIN / UDB_OTP / SUBS_LOGIN / SUBS_OTP / POPUP / SLP / SAP / SRP / SUBS_PAYMENT_GATEWAY / FAV / FAV_ICON / USER_BAR / RECOMMENDATION_POPUP | REQUIRED |
anonId | uuid | A unique anonymous ID for each user. | REQUIRED |
userId | string | A unique ID of the order after making a transaction. | REQUIRED |
Last updated