inGameSessionEvent
v1.0.0

The in-Game Session Tracking type of event received from the game clients.
flowchart LR l-Game_Client[Game Client]:::producer-->inGameSessionEvent[inGameSessionEvent]:::event classDef event stroke:#fbd901,stroke-width: 4px; classDef producer stroke:#75d7b6,stroke-width: 2px; classDef consumer stroke:#818cf8,stroke-width: 2px; inGameSessionEvent[inGameSessionEvent]:::event-->r-Thunderstruck_Real_Time_Game_Messaging_API[Thunderstruck Real Time Game Messaging API]:::consumer inGameSessionEvent[inGameSessionEvent]:::event-->r-Profiling_Service[Profiling Service]:::consumer inGameSessionEvent[inGameSessionEvent]:::event-->r-Statistics_Service[Statistics Service]:::consumer inGameSessionEvent[inGameSessionEvent]:::event-->r-Bayesian_Service[Bayesian Service]:::consumer inGameSessionEvent[inGameSessionEvent]:::event-->r-Classifications_Service[Classifications Service]:::consumer inGameSessionEvent[inGameSessionEvent]:::event-->r-Recommendation_Service[Recommendation Service]:::consumer click l-Game_Client href "/services/Game Client" "Go to Game Client" _self click r-Thunderstruck_Real_Time_Game_Messaging_API href "/services/Thunderstruck Real Time Game Messaging API" "Go to Thunderstruck Real Time Game Messaging API" _self click r-Profiling_Service href "/services/Profiling Service" "Go to Profiling Service" _self click r-Statistics_Service href "/services/Statistics Service" "Go to Statistics Service" _self click r-Bayesian_Service href "/services/Bayesian Service" "Go to Bayesian Service" _self click r-Classifications_Service href "/services/Classifications Service" "Go to Classifications Service" _self click r-Recommendation_Service href "/services/Recommendation Service" "Go to Recommendation Service" _self click inGameSessionEvent href "/events/inGameSessionEvent" "Go to inGameSessionEvent" _self
inGameSessionEvent Schema (json)
{
    "allOf": [
        {
            "description": "The Eventing payload of the platform",
            "title": "Event Log record",
            "type": "object",
            "properties": {
                "eventId": {
                    "description": "The type that is used to refer to an id of another instance in the system",
                    "type": "string",
                    "title": "The ID (UUID) reference type"
                },
                "version": {
                    "default": "$LATEST",
                    "description": "The type that is used to refer to the eventing version",
                    "type": "string",
                    "title": "The Version reference type (Semver)"
                },
                "appId": {
                    "description": "The type that is used to refer to an id of another instance in the system",
                    "type": "string",
                    "title": "The ID (UUID) reference type"
                },
                "userId": {
                    "description": "The type that is used to refer to an id of another instance in the system",
                    "type": "string",
                    "title": "The ID (UUID) reference type"
                },
                "sessionId": {
                    "description": "The type that is used to refer to an id of another instance in the system",
                    "type": "string",
                    "title": "The ID (UUID) reference type"
                },
                "playerId": {
                    "description": "The type that is used to refer to an id of another instance in the system",
                    "type": "string",
                    "title": "The ID (UUID) reference type"
                },
                "installationId": {
                    "description": "The type that is used to refer to an id of another instance in the system",
                    "type": "string",
                    "title": "The ID (UUID) reference type"
                },
                "sourceContext": {
                    "description": "The Eventing Source Meta Context",
                    "title": "The Source Context",
                    "type": "object",
                    "properties": {
                        "path": {
                            "type": "string"
                        },
                        "referrer": {
                            "type": "string"
                        },
                        "search": {
                            "type": "string"
                        },
                        "environment": {
                            "type": "string"
                        },
                        "realmId": {
                            "description": "The type that is used to refer to an id of another instance in the system",
                            "type": "string",
                            "title": "The ID (UUID) reference type"
                        },
                        "method": {
                            "type": "string"
                        },
                        "worldId": {
                            "description": "The type that is used to refer to an id of another instance in the system",
                            "type": "string",
                            "title": "The ID (UUID) reference type"
                        },
                        "shardId": {
                            "description": "The type that is used to refer to an id of another instance in the system",
                            "type": "string",
                            "title": "The ID (UUID) reference type"
                        },
                        "title": {
                            "type": "string"
                        },
                        "serverId": {
                            "description": "The type that is used to refer to an id of another instance in the system",
                            "type": "string",
                            "title": "The ID (UUID) reference type"
                        },
                        "url": {
                            "type": "string"
                        }
                    }
                },
                "value": {
                    "description": "The Value Event class",
                    "title": "The Value payload",
                    "type": "object",
                    "properties": {
                        "ad": {
                            "description": "All the values for Ad interactions",
                            "title": "The Ad Value Payload",
                            "type": "object",
                            "properties": {
                                "quartile": {
                                    "type": "number"
                                },
                                "placementId": {
                                    "type": "string"
                                },
                                "placementName": {
                                    "type": "string"
                                },
                                "publisher": {
                                    "type": "string"
                                },
                                "position": {
                                    "type": "number"
                                },
                                "totalLength": {
                                    "type": "number"
                                }
                            }
                        },
                        "customMeta": {
                            "type": "object"
                        },
                        "social": {
                            "description": "All the values for price-based asking, listing & biding interactions",
                            "title": "The price Value Payload",
                            "type": "object",
                            "properties": {
                                "groupName": {
                                    "type": "string"
                                },
                                "sender": {
                                    "type": "string"
                                },
                                "recipient": {
                                    "type": "string"
                                },
                                "rating": {
                                    "type": "string"
                                },
                                "message": {
                                    "type": "string"
                                },
                                "via": {
                                    "type": "string"
                                }
                            }
                        },
                        "customValue": {
                            "type": "number"
                        },
                        "txType": {
                            "description": "All the values to set what kind of transaction is it",
                            "title": "The TransactionType",
                            "type": "object",
                            "properties": {
                                "isRenewal": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isFXTrade": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isReward": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isPurchase": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isGained": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isContract": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isAdReward": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isRedeem": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isLoot": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isSale": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isTrade": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isDrop": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isInappPurchase": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isAchievementReward": {
                                    "default": false,
                                    "type": "boolean"
                                }
                            }
                        },
                        "customRef": {
                            "type": "string"
                        },
                        "prize": {
                            "description": "All the values for prize/rewards-based interactions",
                            "title": "The prize/rewards Value Payload",
                            "type": "object",
                            "properties": {
                                "amount": {
                                    "type": "number"
                                },
                                "level": {
                                    "type": "number"
                                },
                                "name": {
                                    "type": "string"
                                },
                                "isUnique": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isCurrency": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "isItem": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "id": {
                                    "type": "string"
                                },
                                "value": {
                                    "type": "number"
                                }
                            }
                        },
                        "content": {
                            "description": "All the values for content-based interactions",
                            "title": "The Content Value Payload",
                            "type": "object",
                            "properties": {
                                "count": {
                                    "type": "number"
                                },
                                "term": {
                                    "type": "string"
                                },
                                "title": {
                                    "type": "string"
                                },
                                "uri": {
                                    "type": "string"
                                },
                                "isIPFS": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "key": {
                                    "type": "string"
                                }
                            }
                        },
                        "mission": {
                            "description": "All the values for Mission/Quest/Level/Session/Matchmaking/Season interactions",
                            "title": "The mission Value Payload",
                            "type": "object",
                            "properties": {
                                "duration": {
                                    "type": "number"
                                },
                                "score": {
                                    "type": "number"
                                },
                                "moves": {
                                    "type": "number"
                                },
                                "rankName": {
                                    "type": "string"
                                },
                                "rank": {
                                    "type": "number"
                                },
                                "remaining": {
                                    "type": "number"
                                }
                            }
                        },
                        "identity": {
                            "description": "All the values to keep track of the profile and user",
                            "title": "The identity Value Payload",
                            "type": "object",
                            "required": [
                                "profileId",
                                "anonymous"
                            ],
                            "properties": {
                                "wallet": {
                                    "description": "The type that is used to refer to an id of another instance in the system",
                                    "type": "string",
                                    "title": "The ID (UUID) reference type"
                                },
                                "profileId": {
                                    "description": "The type that is used to refer to an id of another instance in the system",
                                    "type": "string",
                                    "title": "The ID (UUID) reference type"
                                },
                                "anonymous": {
                                    "default": true,
                                    "type": "boolean"
                                },
                                "userId": {
                                    "description": "The type that is used to refer to an id of another instance in the system",
                                    "type": "string",
                                    "title": "The ID (UUID) reference type"
                                },
                                "plan": {
                                    "type": "string"
                                },
                                "email": {
                                    "type": "string"
                                },
                                "username": {
                                    "type": "string"
                                }
                            }
                        },
                        "price": {
                            "description": "All the values for price-based asking, listing & biding interactions",
                            "title": "The price Value Payload",
                            "type": "object",
                            "properties": {
                                "currencyType": {
                                    "type": "string"
                                },
                                "amount": {
                                    "description": "For either asking or bidding price",
                                    "type": "number"
                                },
                                "currency": {
                                    "type": "string"
                                }
                            }
                        },
                        "transaction": {
                            "description": "All the values for Transaction interactions",
                            "title": "The Transaction Payload",
                            "type": "object",
                            "properties": {
                                "orderId": {
                                    "type": "string"
                                },
                                "renewalCount": {
                                    "default": 0,
                                    "type": "number"
                                },
                                "network": {
                                    "type": "string"
                                },
                                "receiverId": {
                                    "type": "string"
                                },
                                "feesTotal": {
                                    "type": "number"
                                },
                                "priceTotal": {
                                    "type": "number"
                                },
                                "currency": {
                                    "type": "string"
                                },
                                "id": {
                                    "type": "string"
                                },
                                "amount": {
                                    "type": "number"
                                },
                                "quantity": {
                                    "type": "number"
                                },
                                "receiverName": {
                                    "type": "string"
                                },
                                "storeId": {
                                    "type": "string"
                                },
                                "transactorName": {
                                    "type": "string"
                                },
                                "virtualCurrency": {
                                    "type": "string"
                                },
                                "blob": {
                                    "type": "string"
                                },
                                "transactorId": {
                                    "type": "string"
                                },
                                "discountTotal": {
                                    "type": "number"
                                },
                                "paymentProvider": {
                                    "type": "string"
                                },
                                "receiverType": {
                                    "type": "string"
                                },
                                "paymentMethod": {
                                    "type": "string"
                                },
                                "receipt": {
                                    "type": "string"
                                },
                                "virtualAmount": {
                                    "type": "number"
                                },
                                "checkoutId": {
                                    "type": "string"
                                },
                                "virtualCurrencyType": {
                                    "type": "string"
                                },
                                "receiptSignature": {
                                    "type": "string"
                                },
                                "storeSourceId": {
                                    "type": "string"
                                },
                                "transactorType": {
                                    "type": "string"
                                }
                            }
                        },
                        "linkedContent": {
                            "description": "All the values for content-based interactions",
                            "title": "The Content Value Payload",
                            "type": "object",
                            "properties": {
                                "count": {
                                    "type": "number"
                                },
                                "term": {
                                    "type": "string"
                                },
                                "title": {
                                    "type": "string"
                                },
                                "uri": {
                                    "type": "string"
                                },
                                "isIPFS": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "key": {
                                    "type": "string"
                                }
                            }
                        },
                        "gear": {
                            "description": "All the values for gear-based acquisition interactions",
                            "title": "The gear Value Payload",
                            "type": "object",
                            "properties": {
                                "level": {
                                    "type": "number"
                                },
                                "isUnique": {
                                    "default": false,
                                    "type": "boolean"
                                },
                                "value": {
                                    "type": "number"
                                },
                                "class": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                },
                "eventSinceAppstart": {
                    "default": 0,
                    "description": "event since app start, 0 if N/A",
                    "type": "integer"
                },
                "sentAt": {
                    "type": "integer"
                },
                "receivedAt": {
                    "type": "integer"
                },
                "doTrack": {
                    "default": true,
                    "type": "boolean"
                },
                "expiresAt": {
                    "type": "integer"
                },
                "timestamp": {
                    "type": "integer"
                },
                "linkedProduct": {
                    "description": "The list of linked Product that are associated with this event",
                    "title": "Event Linked Product",
                    "type": "array",
                    "items": {
                        "description": "The Product class describes the linked product reference",
                        "title": "The Product payload",
                        "type": "object",
                        "required": [
                            "productId"
                        ],
                        "properties": {
                            "imageUri": {
                                "type": "string"
                            },
                            "quantity": {
                                "type": "number"
                            },
                            "productId": {
                                "description": "The type that is used to refer to an id of another instance in the system",
                                "type": "string",
                                "title": "The ID (UUID) reference type"
                            },
                            "price": {
                                "type": "number"
                            },
                            "name": {
                                "type": "string"
                            },
                            "variant": {
                                "type": "string"
                            },
                            "currency": {
                                "type": "string"
                            },
                            "sku": {
                                "type": "string"
                            },
                            "category": {
                                "type": "string"
                            },
                            "brand": {
                                "type": "string"
                            },
                            "uri": {
                                "type": "string"
                            }
                        }
                    }
                },
                "linkedAssets": {
                    "description": "The list of linked assets that are associated with this event",
                    "title": "Event Linked Assets",
                    "type": "array",
                    "items": {
                        "description": "The Asset class describes the in-game item payload",
                        "title": "The Asset payload",
                        "type": "object",
                        "required": [
                            "assetId",
                            "typeList"
                        ],
                        "properties": {
                            "outputs": {
                                "type": "array",
                                "items": {
                                    "description": "The type that is used to refer to an id of another instance in the system",
                                    "type": "string",
                                    "title": "The ID (UUID) reference type"
                                }
                            },
                            "variables": {
                                "type": "array",
                                "items": {
                                    "description": "The Asset Variable class describes the attribute of the Asset value",
                                    "title": "The AssetVariable payload",
                                    "type": "object",
                                    "required": [
                                        "type",
                                        "key",
                                        "value"
                                    ],
                                    "properties": {
                                        "variations": {
                                            "type": "array",
                                            "items": {
                                                "description": "The Asset Variable Variation describes Whether this variable needs to be different based on a key condition",
                                                "title": "The Variable Variation",
                                                "type": "object",
                                                "required": [
                                                    "type",
                                                    "key",
                                                    "value"
                                                ],
                                                "properties": {
                                                    "type": {
                                                        "default": "Default",
                                                        "description": "Whether this is a variation variable",
                                                        "type": "string",
                                                        "title": "Variable Variation Type",
                                                        "enum": [
                                                            "Mapping",
                                                            "Leveling",
                                                            "Class",
                                                            "Time",
                                                            "Default"
                                                        ]
                                                    },
                                                    "value": {
                                                        "type": "number"
                                                    },
                                                    "key": {
                                                        "type": "string"
                                                    }
                                                }
                                            }
                                        },
                                        "type": {
                                            "default": "Number",
                                            "description": "What kind of value the variable holds",
                                            "type": "string",
                                            "title": "Variable Type",
                                            "enum": [
                                                "Probability",
                                                "Quantity",
                                                "Quality",
                                                "Rate",
                                                "Number",
                                                "Percentage",
                                                "Time"
                                            ]
                                        },
                                        "value": {
                                            "type": "number"
                                        },
                                        "key": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "typeList": {
                                "uniqueItems": true,
                                "type": "array",
                                "minimum": 1,
                                "items": {
                                    "default": "Resource",
                                    "description": "Describes the type class of the asset",
                                    "type": "string",
                                    "title": "Asset Type",
                                    "enum": [
                                        "Resource",
                                        "Item",
                                        "Craft",
                                        "Input",
                                        "Modifier",
                                        "Profile",
                                        "Character"
                                    ]
                                }
                            },
                            "assetId": {
                                "description": "The type that is used to refer to an id of another instance in the system",
                                "type": "string",
                                "title": "The ID (UUID) reference type"
                            },
                            "inputs": {
                                "type": "array",
                                "items": {
                                    "description": "The type that is used to refer to an id of another instance in the system",
                                    "type": "string",
                                    "title": "The ID (UUID) reference type"
                                }
                            },
                            "categories": {
                                "type": "array",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "classification": {
                                "type": "string"
                            }
                        }
                    }
                }
            }
        },
        {
            "type": "string",
            "description": "Describes the body of the value",
            "title": "Event Type",
            "enum": [
                "SessionNew",
                "SessionStart",
                "SessionStop",
                "SessionResult",
                "SessionRank",
                "SessionQuit",
                "SessionFail",
                "SessionSkip",
                "MissionNew",
                "MissionStart",
                "MissionStop",
                "MissionResult",
                "MissionRank",
                "MissionQuit",
                "MissionFail",
                "MissionSkip",
                "QuestNew",
                "QuestStart",
                "QuestStop",
                "QuestResult",
                "QuestRank",
                "QuestQuit",
                "QuestFail",
                "QuestSkip",
                "LevelNew",
                "LevelStart",
                "LevelStop",
                "LevelResult",
                "LevelRank",
                "LevelQuit",
                "LevelFail",
                "LevelSkip",
                "SeasonNew",
                "SeasonStart",
                "SeasonStop",
                "SeasonResult",
                "SeasonRank",
                "SeasonQuit",
                "SeasonFail",
                "SeasonSkip",
                "MatchmakingNew",
                "MatchmakingStart",
                "MatchmakingStop",
                "MatchmakingResult",
                "MatchmakingRank",
                "MatchmakingQuit",
                "MatchmakingFail",
                "MatchmakingSkip"
            ]
        }
    ]
}
Last updated on 2022/6/3