> For the complete documentation index, see [llms.txt](https://lionstudios.gitbook.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lionstudios.gitbook.io/readme/analytics/api/events.md). # Events {% tabs %} {% tab title="All Events" %}

Client Function	Description
Achievement	The player completed an achievement. This event can also record the rewards for this achievement.
BannerRevenuePaid	A banner ad's revenue was paid
BannerShowRequested	A banner ad was requested to shown
CharacterCreated	The player created a new character.
CharacterDeleted	The player deleted a character.
CharacterUpdated	The player updated a characters information.
DebugEvent	Anything happened which is not covered by other events but is needed to debug or understand a situation
Economy	The player bought, sold or exchanged something in the game
ErrorEvent	The game had an expected error or issue
FeatureUnlocked	The player unlocked a level, item, badge, level, skills or anything else.
FunnelEvent	A funnel event test
GameStart	The game started. This event is now fired automatically at the end of Lion SDK initialization.
GiftReceived	The player received a gift from another player
GiftSent	The player sent a gift to another player
HandAction	This event is a poker specific event used to track the betting rounds within a hand of poker.
Heartbeat	Fired automatically by LionAnalytics. No action required.
InAppPurchase	The player purchased an IAP
InterstitialClick	An interstitial ad was clicked
InterstitialEnd	An interstitial ad ended
InterstitialLoad	An interstitial ad was loaded
InterstitialLoadFail	An interstitial ad failed to load
InterstitialRevenuePaid	A interstitial video ad’s revenue was paid
InterstitialShow	An interstitial ad was requested to show
InterstitialShowFail	An interstitial ad failed to show
InterstitialTryShow	An interstitial ad was requested to show
InviteReceived	The player received an invite to a set of users
InviteRewarded	The player received a reward for inviting another player.
InviteSent	The player sent an invite to the game
ItemActioned	The player used an item.
ItemCollected	The player picked up or was gifted an item.
LevelUp	The player leveled up. Note this is different than completing a game “level”. In this situation, if your game has the concept of “player levels”, use this event. Traditionally, “players levels” are linked with “experience points” earned during game play.
MissionAbandoned	The player abandoned a mission
MissionCompleted	The player completed a mission
MissionFailed	The player failed a mission
MissionStarted	The player started a mission
MissionStep	This event allows you to track partial progress towards completing a mission. If there are some natural steps or breakpoints during a mission, fire the MissionStep events.
NewPlayer	A new player entered the game
NotificationOpened	The game was launched through a push notification, or a notification was received.
Options	Use this event to track when a player changes game option on the settings screen (e.g. toggle audio on/off, enable notifications, etc).
PowerUpUsed	The player used a power up or boost.
PredictionResult	If your game is using any predictive models (e.g. Multi-arm Bandit) or other machine learning algorithms to pull levers in your game, use this event to track the prediction related to the player. Sin
ProductViewed	The player looked at a product’s description, or viewed an item. This is designed to capture a player’s interest.
RewardVideoClick	A rewarded video ad was clicked
RewardVideoCollect	A rewarded video’s reward was collected
RewardVideoEnd	A rewarded video ad ended
RewardVideoLoad	A rewarded video ad was loaded
RewardVideoLoadFail	A rewarded video ad failed to load
RewardVideoOpportunity	The player was presented with the option for a rewarded video.
RewardVideoRevenuePaid	A rewarded video ad's revenue was paid
RewardVideoShow	A rewarded video ad was requested to show
RewardVideoShowFail	A rewarded video ad failed to show
RewardVideoTryShow	A rewarded video ad was requested to show
ShopEntered	The player accessed the shop.
SkillUpgraded	The player upgraded one of their character’s skills.
SkillUsed	The player used a skill in game (cast fireball, used bomb, used swing…)
Social	A social interaction took place
SocialConnect	The player connected to a social network
Support	Use this event allows to track when players use in-game tools to contact Lion Studios Support with questions.
UiInteraction	The player interacted with parts of the user interface, specifically pressed buttons to view specific features and navigate around.

{% endtab %} {% tab title="Gameplay" %}

Client Function	Description
Achievement	The player completed an achievement. This event can also record the rewards for this achievement.
CharacterCreated	The player created a new character.
CharacterDeleted	The player deleted a character.
CharacterUpdated	The player updated a characters information.
FeatureUnlocked	The player unlocked a level, item, badge, level, skills or anything else.
GameStart	The game started. This event is now fired automatically at the end of Lion SDK initialization.
HandAction	This event is a poker specific event used to track the betting rounds within a hand of poker.
ItemActioned	The player used an item.
ItemCollected	The player picked up or was gifted an item.
LevelUp	The player leveled up. Note this is different than completing a game “level”. In this situation, if your game has the concept of “player levels”, use this event. Traditionally, “players levels” are linked with “experience points” earned during game play.
NewPlayer	A new player entered the game
NotificationOpened	The game was launched through a push notification, or a notification was received.
Options	Use this event to track when a player changes game option on the settings screen (e.g. toggle audio on/off, enable notifications, etc).
PowerUpUsed	The player used a power up or boost.
ProductViewed	The player looked at a product’s description, or viewed an item. This is designed to capture a player’s interest.
ShopEntered	The player accessed the shop.
SkillUpgraded	The player upgraded one of their character’s skills.
SkillUsed	The player used a skill in game (cast fireball, used bomb, used swing…)
UiInteraction	The player interacted with parts of the user interface, specifically pressed buttons to view specific features and navigate around.

{% endtab %} {% tab title="Ads" %}

Client Function	Description
BannerShowRequested	A banner ad was requested to shown
InterstitialClick	An interstitial ad was clicked
InterstitialEnd	An interstitial ad ended
InterstitialLoad	An interstitial ad was loaded
InterstitialLoadFail	An interstitial ad failed to load
InterstitialShow	An interstitial ad was requested to show
InterstitialShowFail	An interstitial ad failed to show
InterstitialTryShow	An interstitial ad was requested to show
RewardVideoClick	A rewarded video ad was clicked
RewardVideoCollect	A rewarded video’s reward was collected
RewardVideoEnd	A rewarded video ad ended
RewardVideoLoad	A rewarded video ad was loaded
RewardVideoLoadFail	A rewarded video ad failed to load
RewardVideoOpportunity	The player was presented with the option for a rewarded video.
RewardVideoShow	A rewarded video ad was requested to show
RewardVideoShowFail	A rewarded video ad failed to show
RewardVideoTryShow	A rewarded video ad was requested to show

{% endtab %} {% tab title="Monetization" %}

Client Function	Description
Economy	The player bought, sold or exchanged something in the game
InAppPurchase	The player purchased an IAP

{% endtab %} {% tab title="Social" %}

Client Function	Description
GiftReceived	The player received a gift from another player
GiftSent	The player sent a gift to another player
InviteReceived	The player received an invite to a set of users
InviteRewarded	The player received a reward for inviting another player.
InviteSent	The player sent an invite to the game
Social	A social interaction took place
SocialConnect	The player connected to a social network
Support	Use this event allows to track when players use in-game tools to contact Lion Studios Support with questions.

{% endtab %} {% tab title="Progression" %}

Client Function	Description
MissionAbandoned	The player abandoned a mission
MissionCompleted	The player completed a mission
MissionFailed	The player failed a mission
MissionStarted	The player started a mission
MissionStep	This event allows you to track partial progress towards completing a mission. If there are some natural steps or breakpoints during a mission, fire the MissionStep events.

{% endtab %} {% tab title="Debug" %}

Client Function	Description
DebugEvent	Anything happened which is not covered by other events but is needed to debug or understand a situation
ErrorEvent	The game had an expected error or issue

{% endtab %} {% tab title="Experiments" %}

Client Function	Description
FunnelEvent	A funnel event test
PredictionResult	If your game is using any predictive models (e.g. Multi-arm Bandit) or other machine learning algorithms to pull levers in your game, use this event to track the prediction related to the player. Sin

{% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://lionstudios.gitbook.io/readme/analytics/api/events.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.