All Event Parameters

LionAnalytics Parameter List

Parameters
Name Type Select Backend name Description
achievementID string Required achievement_id achievementID is an ID that represents the achievement.
achievementName string Required achievement_name achievementName is the name of the achievement in the game.
action string Required action Name of the action taken by player.
additionalData Dictionary Optional additional_data Any additional information
amount int Required amount The amount the player BET / RAISED if applicable.
attemptNum int Optional level_attempt The attempt number
campaignID int Required campaign_id Unique ID of the out of game campaign.
campaignName string Required campaign_name Name of the out of game campaign.
characterClass string Required character_class Class of the character being created.
characterGender string Required character_gender The gender of the character being created.
characterID string Required character_id The ID of the character.
characterName string Required character_name The name of the character
cohortGroup string Required cohort_group Group identifier of the cohort within the campaign.
cohortID int Required cohort_id ID of the cohort within the campaign.
cohortName string Required cohort_name Name of the cohort.
communicationSender string Required communication_sender Communication sender used.
communicationState string Required communication_state Communication state that has been reached.
connectedUserId string Required connected_user_id The userID provided to deltaDNA when the player is playing on other devices whilst connected to a social network.
currencyType string Optional The type of currency used to buy the purchase. The default is USD
currentSkillLevel int Required current_skill_level The current skill level before the upgrade.
errorType ErrorEventType Required error_type The error type
experimentCohort string Required experiment_cohort The the variant or cohort name.
experimentName string Required experiment_name The experiment name
featureName string Required feature_name FeatureName is the name of the feature that has been unlocked.
featureType string Required feature_type FeatureType is the type of feature that has been unlocked.
funnelLabel string Optional funnel_label The funnel label
funnelStep int Required funnel_step The funnel step
funnelValue int Optional funnel_value The value of the funnel
gameID string Required game_id The unique ID for the game, this ID links the multiplayer session so each player in the game has the same ID.
gift Reward Required reward The reward object which contains the name, type, amount and such.
giftAccepted bool Optional gift_accepted If the gift is accepted. Default value is false
handID string Required hand_id The unique ID for the specific hand of poker in the game.
inviteType string Optional invite_type inviteType is the system used to drive the invite
isInviteAccepted bool Optional is_invite_accepted Has the invite been accepted
isTutorial bool Required is_tutorial Is it a tutorial?
itemID string Required item_id Internal ID of an item within the game
itemName string Required item_name Name of the item
itemType string Required item_type The type of item that is being interacted with, could be a spell, weapon, etc.
level int Optional level_num
levelCollection1 string Optional level_collection1 The level collection
levelCollection2 string Optional level_collection2
levelNum int Required level_num The level number
levelUpName string Required level_up_name The level up name
message string Required message The message to print to help debug.
missionAttempt int Required mission_attempt Number of times user has played Game Level N (second play of Game Level N = 2)
missionID string Required mission_id The unique ID for the mission.
missionName string Optional mission_name
missionType string Optional mission_type Indicate the type of the mission, level, task, quests etc.
modelInput object Required model_input JSON formatted data with model’s input. The actual input can be key-value pairs or arrays depending on the model.
modelName string Required model_name The name of the model which could be descriptive to its usage.
modelOutput object Required model_output JSON formatted result from calling the model. Either single key-value pair or multiple key-value pairs.
modelVersion string Required model_version The version of the model
network string Optional ad_provider The SDK the ad will be from (i.e, Adjust, FB, etc)
newSkillLevel int Required new_skill_level The new skill level after the upgrade.
notificationID int Required notification_id Identifier for notification.
notificationLaunch string Required notification_launch Did the push notification launch the game.
notificationName string Required notification_name The name of the notification that targeted the player.
option string Required option The option that was selected.
placement string Required placement The placement of the ad
powerUpName string Required power_up_name The name of the power up.
productID string Optional product_id The Store SKU of the purchase unit
purchaseLocation string Optional placement The location in the app where the purchase was made
purchaseName string Required purchase_name Name of the purchase/pack the user bought
realCurrencyAmount float Required the localized price of the purchase
realCurrencyType string Required The type of real currency (USD, Euros, etc). Lion Analytics will automatically convert the localized price based on the ‘realCurrencyType’ (currency code) provided.
reason AdErrorType Optional adErrorType Used to record error messages when loading ads
reasonForFailure string Required reason_for_failure If an action failed, e.g., success is false, indicate reason for failure. E.g., skill_incorrectly_used.
receiptStatus ReceiptStatus Optional validated_receipt A receipt status object
receivedProducts Product Required received_products The user receives the product
recipientID string Required recipient_id The recipient ID
reward Reward Required reward If rewards are given to the player at the time of the event, the reward object is used to track the items (e.g., boosters, coins, gems, etc) or currencies gifted or earned by the player to the player.
roundAction string Required round_action The action a player took in the round.
roundName string Required round_name The name of the betting round e.g. PREFLOP/FLOP/TURN/RIVER…
score int Optional user_score The game score
senderID string Required sender_id The sender ID
shopID string Optional shop_id This should be the internal ID of the shop accessed.
shopName string Required shop_name This should be the name of the shop accessed.
shopType string Optional shop_type This should be the type of shop accessed. If there are multiple types of shops, such as Weapon, Currency, etc., use the shop_type parameter to differentiate them.
skillID string Required skill_id The internal ID of the skill being used
skillName string Required skill_name Name of the skill being used e.g. Fireball, Big Swing
socialAlias string Optional social_alias The player name / alias on the social network.
socialPlatform string Optional social_platform socialPlatform is the type of social activity that generated the reward.
socialType string Required social_type The social type
spentProducts Product Required spent_products What products the user spent on
success bool Required success Indicates success or failure
ticketID string Required ticked_id Ticket ID
transaction Transaction Required transaction Transaction object
transactionID string Optional transaction_id The receipt ID provided by the Store
uiAction string Required ui_action uiAction is the action taken on the User Interface object.
uiLocation string Optional ui_location uiLocation is the position in the game where the User Interface object is.
uiName string Required ui_name uiName is the name that defines the interaction.
uiType string Optional ui_type uiType is the type of User Interface object.
uniqueTracking string Optional unique_tracking This is used to match a Sent event with corresponding Received event.
userScore int Required user_score The player’s score
viewedProductID string Required viewed_product_id The internal ID of the viewed product. The product/IAP that’s being viewed by the player. viewed_product_id should be the store bundle id, such as com.vottzapps.wordle.starterpack1.
viewedProductName string Required viewed_product_name The name of the viewed product. The product/IAP that’s being viewed by the player. viewed_product_name should be the display name of the package, e.g., Starter Pack.
virtualCurrencyAmount int Required The virtual Currency amount in game
virtualCurrencyName string Required The virtual currency name used in the game
virtualCurrencyType string Required The type of virtual currency used in the game.
isUAEvent bool Optional is_ua_event Is it an User Acquisition event?
missionID string Optional mission_id
inviterId string Optional inviter_id The ID of the player who sent out a invite to a game
inviteeId string Optional invitee_id The ID of the player who received an invite to a game from another player
failReason string Optional fail_reason