Skip to content

Prediction event

The prediction event is the top-level object emitted per player. The table below lists its root fields; nested object types are documented in the sections that follow, and the links in the Type column jump to them.

FieldTypeDescription
playerrequiredobject
customerLTVoptionallifeTimeValuePrediction
churnRiskoptionalchurnRiskPrediction
sessionChurnRiskoptionalsessionChurnRiskPrediction
incentiveUsageoptionalincentiveUsagePrediction
incentiveGuidanceoptionalincentiveGuidancePrediction
reactivationPotentialoptionalreactivationPotentialPrediction
incentiveRecommendationsoptionalarray of incentiveRecommendation
favoriteGameCategoriesoptionalarray of favoriteGameCategory
recommendedGamesoptionalarray of recommendedGame
FieldTypeDescription
idrequiredstring
cohortrequirednumber
grouprequiredTargetControl
siteIdoptionaldeprecatednumberDEPRECATED: use `metadata` instead (e.g. metadata={"siteId": 123}). Retained for backward compatibility; removed in a future major version.
metadataoptionalobjectFree-form, customer-specific key/value pairs (e.g. siteId, brand, region). Not validated by the schema.
FieldTypeDescription
currentrequiredlifeTimeValuePredictionEntry
previousoptionallifeTimeValuePredictionEntry
FieldTypeDescription
scorerequirednumberLife-Time Value Score
sequencerequirednumbermin 1 / max 4A numeric representation of the player based on the LTV score
segmentrequired1. Low2. Core3. High4. VIPThe segment name of the player based on the LTV score
daterequiredstringISO8601 date-time
FieldTypeDescription
currentrequiredchurnRiskPredictionEntry
previousoptionalchurnRiskPredictionEntry
FieldTypeDescription
scorerequirednumbermin 0 / max 1Churn Risk Score
sequencerequirednumbermin 1 / max 4A numeric representation of the player based on the churn risk score
segmentrequired1. Low2. Medium3. High4. DormantThe segment name of the player based on the Risk Score
daterequiredstringISO8601 date-time
FieldTypeDescription
currentrequiredsessionChurnRiskPredictionEntry
previousoptionalsessionChurnRiskPredictionEntry
FieldTypeDescription
scorerequirednumbermin 0 / max 1Session Churn Risk Score
sequencerequirednumbermin 1 / max 4A numeric representation of the player based on the churn risk score
segmentrequired1. Low2. Medium3. High4. DormantThe segment name of the player based on the Risk Score
daterequiredstringISO8601 date-time
FieldTypeDescription
currentrequiredincentiveUsagePredictionEntry
previousoptionalincentiveUsagePredictionEntry
FieldTypeDescription
scorerequirednumberIncentive Usage Score
sequencerequirednumbermin 1 / max 4A numeric representation of the player based on the churn risk score
segmentrequired0. No bonus usage1. Normal bonus usage2. Increased bonus usage3. Bonus abuserThe segment name of the player based on the incentive usage score
daterequiredstringISO8601 date-time
FieldTypeDescription
currentrequiredincentiveGuidancePredictionEntry
previousoptionalincentiveGuidancePredictionEntry
FieldTypeDescription
scorerequirednumberIncentive Guidance Score
sequencerequirednumbermin 1 / max 4A numeric representation of the recommended incentive posture
segmentrequired1. Increase Incentives2. Continue Incentives3. Limit Incentives4. Avoid IncentivesRecommended incentive posture for the player
daterequiredstringISO8601 date-time
FieldTypeDescription
currentrequiredreactivationPotentialPredictionEntry
previousoptionalreactivationPotentialPredictionEntry
FieldTypeDescription
scorerequirednumbermin 0 / max 1Reactivation Potential Score
sequencerequirednumbermin 1 / max 3A numeric representation of the player's reactivation potential
segmentrequired1. Low Potential2. Medium Potential3. High PotentialThe segment name of the player's reactivation potential
daterequiredstringISO8601 date-time
FieldTypeDescription
recommendationIdrequiredstringUnique identifier for this recommendation emission
rankrequirednumber1-based rank of the recommendation for the player
scorerequirednumberScore
incentiveIdrequiredstringIdentifier of the recommended incentive type
incentiveNamerequiredstringIncentive Name
amountrequirednumberAmount
FieldTypeDescription
rankrequirednumber
scorerequirednumber
categoryIdrequiredstring
categoryNamerequiredstring
FieldTypeDescription
rankrequirednumber
scorerequirednumber
gameIdrequiredstring
gameNamerequiredstring
categoryIdrequiredstring
categoryNamerequiredstring
{
"player": {
"id": "PLAYER-ID-AS-GUID-OR-NUMERIC-123",
"cohort": 1,
"group": "Target",
"metadata": {
"siteId": 123,
"brand": "GoldenWhale",
"region": "EU"
}
},
"customerLTV": {
"current": {
"score": 1234.45,
"sequence": 4,
"segment": "4. VIP",
"date": "2023-11-20T13:45:00+02:00"
},
"previous": {
"score": 1230.45,
"sequence": 4,
"segment": "4. VIP",
"date": "2023-11-19T13:45:00+02:00"
}
},
"sessionChurnRisk": {
"current": {
"score": 0.2,
"sequence": 2,
"segment": "2. Medium",
"date": "2023-11-20T13:45:00+02:00"
},
"previous": {
"score": 0.19634,
"sequence": 1,
"segment": "1. Low",
"date": "2023-11-12T13:45:00+02:00"
}
},
"churnRisk": {
"current": {
"score": 0.89634,
"sequence": 3,
"segment": "3. High",
"date": "2023-11-20T13:45:00+02:00"
}
},
"incentiveUsage": {
"current": {
"score": 4,
"sequence": 4,
"segment": "3. Bonus abuser",
"date": "2023-11-20T13:45:00+02:00"
}
},
"incentiveGuidance": {
"current": {
"score": 2,
"sequence": 2,
"segment": "2. Continue Incentives",
"date": "2023-11-20T13:45:00+02:00"
},
"previous": {
"score": 1,
"sequence": 1,
"segment": "1. Increase Incentives",
"date": "2023-11-19T13:45:00+02:00"
}
},
"reactivationPotential": {
"current": {
"score": 0.78,
"sequence": 3,
"segment": "3. High Potential",
"date": "2023-11-20T13:45:00+02:00"
}
},
"incentiveRecommendations": [
{
"recommendationId": "d164def1-c3c2-401e-8a09-1928f8765b0d",
"rank": 1,
"score": 87.17,
"incentiveId": "1",
"incentiveName": "Freebet",
"amount": 2000
},
{
"recommendationId": "24f4d856-b42d-4f38-ac62-cdbc6a0e85a8",
"rank": 2,
"score": 72.9,
"incentiveId": "1",
"incentiveName": "Freebet",
"amount": 200
}
],
"favoriteGameCategories": [
{
"rank": 1,
"score": 0.9876,
"categoryId": "C-1",
"categoryName": "Casino"
}
],
"recommendedGames": [
{
"rank": 1,
"score": 0.7654,
"gameId": "G-123",
"gameName": "Golden Whale Super Spinner",
"categoryId": "C-1",
"categoryName": "Casino"
}
]
}