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.
PredictionEvent
Section titled “PredictionEvent”| Field | Type | Description |
|---|---|---|
playerrequired | object | |
customerLTVoptional | lifeTimeValuePrediction | |
churnRiskoptional | churnRiskPrediction | |
sessionChurnRiskoptional | sessionChurnRiskPrediction | |
incentiveUsageoptional | incentiveUsagePrediction | |
incentiveGuidanceoptional | incentiveGuidancePrediction | |
reactivationPotentialoptional | reactivationPotentialPrediction | |
incentiveRecommendationsoptional | array of incentiveRecommendation | |
favoriteGameCategoriesoptional | array of favoriteGameCategory | |
recommendedGamesoptional | array of recommendedGame |
Player
Section titled “Player”| Field | Type | Description |
|---|---|---|
idrequired | string | |
cohortrequired | number | |
grouprequired | TargetControl | |
siteIdoptionaldeprecated | number | DEPRECATED: use `metadata` instead (e.g. metadata={"siteId": 123}). Retained for backward compatibility; removed in a future major version. |
metadataoptional | object | Free-form, customer-specific key/value pairs (e.g. siteId, brand, region). Not validated by the schema. |
lifeTimeValuePrediction
Section titled “lifeTimeValuePrediction”| Field | Type | Description |
|---|---|---|
currentrequired | lifeTimeValuePredictionEntry | |
previousoptional | lifeTimeValuePredictionEntry |
lifeTimeValuePredictionEntry
Section titled “lifeTimeValuePredictionEntry”| Field | Type | Description |
|---|---|---|
scorerequired | number | Life-Time Value Score |
sequencerequired | numbermin 1 / max 4 | A numeric representation of the player based on the LTV score |
segmentrequired | 1. Low2. Core3. High4. VIP | The segment name of the player based on the LTV score |
daterequired | string | ISO8601 date-time |
churnRiskPrediction
Section titled “churnRiskPrediction”| Field | Type | Description |
|---|---|---|
currentrequired | churnRiskPredictionEntry | |
previousoptional | churnRiskPredictionEntry |
churnRiskPredictionEntry
Section titled “churnRiskPredictionEntry”| Field | Type | Description |
|---|---|---|
scorerequired | numbermin 0 / max 1 | Churn Risk Score |
sequencerequired | numbermin 1 / max 4 | A numeric representation of the player based on the churn risk score |
segmentrequired | 1. Low2. Medium3. High4. Dormant | The segment name of the player based on the Risk Score |
daterequired | string | ISO8601 date-time |
sessionChurnRiskPrediction
Section titled “sessionChurnRiskPrediction”| Field | Type | Description |
|---|---|---|
currentrequired | sessionChurnRiskPredictionEntry | |
previousoptional | sessionChurnRiskPredictionEntry |
sessionChurnRiskPredictionEntry
Section titled “sessionChurnRiskPredictionEntry”| Field | Type | Description |
|---|---|---|
scorerequired | numbermin 0 / max 1 | Session Churn Risk Score |
sequencerequired | numbermin 1 / max 4 | A numeric representation of the player based on the churn risk score |
segmentrequired | 1. Low2. Medium3. High4. Dormant | The segment name of the player based on the Risk Score |
daterequired | string | ISO8601 date-time |
incentiveUsagePrediction
Section titled “incentiveUsagePrediction”| Field | Type | Description |
|---|---|---|
currentrequired | incentiveUsagePredictionEntry | |
previousoptional | incentiveUsagePredictionEntry |
incentiveUsagePredictionEntry
Section titled “incentiveUsagePredictionEntry”| Field | Type | Description |
|---|---|---|
scorerequired | number | Incentive Usage Score |
sequencerequired | numbermin 1 / max 4 | A numeric representation of the player based on the churn risk score |
segmentrequired | 0. No bonus usage1. Normal bonus usage2. Increased bonus usage3. Bonus abuser | The segment name of the player based on the incentive usage score |
daterequired | string | ISO8601 date-time |
incentiveGuidancePrediction
Section titled “incentiveGuidancePrediction”| Field | Type | Description |
|---|---|---|
currentrequired | incentiveGuidancePredictionEntry | |
previousoptional | incentiveGuidancePredictionEntry |
incentiveGuidancePredictionEntry
Section titled “incentiveGuidancePredictionEntry”| Field | Type | Description |
|---|---|---|
scorerequired | number | Incentive Guidance Score |
sequencerequired | numbermin 1 / max 4 | A numeric representation of the recommended incentive posture |
segmentrequired | 1. Increase Incentives2. Continue Incentives3. Limit Incentives4. Avoid Incentives | Recommended incentive posture for the player |
daterequired | string | ISO8601 date-time |
reactivationPotentialPrediction
Section titled “reactivationPotentialPrediction”| Field | Type | Description |
|---|---|---|
currentrequired | reactivationPotentialPredictionEntry | |
previousoptional | reactivationPotentialPredictionEntry |
reactivationPotentialPredictionEntry
Section titled “reactivationPotentialPredictionEntry”| Field | Type | Description |
|---|---|---|
scorerequired | numbermin 0 / max 1 | Reactivation Potential Score |
sequencerequired | numbermin 1 / max 3 | A numeric representation of the player's reactivation potential |
segmentrequired | 1. Low Potential2. Medium Potential3. High Potential | The segment name of the player's reactivation potential |
daterequired | string | ISO8601 date-time |
incentiveRecommendation
Section titled “incentiveRecommendation”| Field | Type | Description |
|---|---|---|
recommendationIdrequired | string | Unique identifier for this recommendation emission |
rankrequired | number | 1-based rank of the recommendation for the player |
scorerequired | number | Score |
incentiveIdrequired | string | Identifier of the recommended incentive type |
incentiveNamerequired | string | Incentive Name |
amountrequired | number | Amount |
favoriteGameCategory
Section titled “favoriteGameCategory”| Field | Type | Description |
|---|---|---|
rankrequired | number | |
scorerequired | number | |
categoryIdrequired | string | |
categoryNamerequired | string |
recommendedGame
Section titled “recommendedGame”| Field | Type | Description |
|---|---|---|
rankrequired | number | |
scorerequired | number | |
gameIdrequired | string | |
gameNamerequired | string | |
categoryIdrequired | string | |
categoryNamerequired | string |
Example payload
Section titled “Example payload”{ "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" } ]}
