Sending analytics to the endpoint URL

How It Works

You can receive data about users’ activity, errors and failures in the Launcher operation sent to your endpoint URL as events and analyze it using any analytics tools. All outgoing events are listed below and grouped based on their type.

Events of opening and activating Launcher windows and screens

EventDescription
Game install windowOpening or activating the Game installation window.
Launcher update windowOpening or activating the Login screen.
Login screenOpening or activating the Login screen.
MailRu login screenOpening or activating the Mail.ru login screen.
Steam login screenOpening or activating the Steam login screen.
Stone login screenOpening or activating the Stone login screen.
Game screenOpening or activating the Game screen.
Maintenance windowOpening or activating the Maintenance window.
Home screenOpening or activating the Home screen.
News screenOpening or activating the News screen.
One news screenOpening or activating the One news screen.
Store screenOpening or activating the Store screen.
Store windowOpening or activating the Store window.
Redeem windowOpening or activating the Key redemption window.
Settings windowOpening or activating the Settings window.

Events of interaction between a user and the Launcher start page elements

EventDescription
StartPage Event: Push InstallClicking the Install button.
StartPage Event: Push startClicking the Play button.
StartPage Event: Open GameOpening the game screen.
StartPage Event: Push Redeem keyRedeeming the key.
StartPage Event: Open newsOpening News.
StartPage Event: Open buyProceeding to purchase.

Events of interaction between a user and the Launcher interface elements

EventDescription
UI Event: Push InstallClicking the Install button.
UI Event: Push PlayClicking the Play button.
UI Event: Push UpdateClicking the Update game button.
UI Event: Push MaintenanceClicking the Maintenance button.
UI Event: Push AdsBannerClicking the ads banner.
UI Event: Push SettingClicking the Settings button.
UI Event: Push LogoutClicking the Log out button.
UI Event: Push UninstallClicking the Uninstall button.
UI Event: Push RepairClicking the Repair button.
UI Event: Push SupportClicking the Support button.
UI Event: Push CommunityClicking the Community button.
UI Event: Push Create AccountClicking the Create Account button.
UI Event: Push Forgot PasswordClicking the Forgot Password button.
UI Event: Push Sign In With SocialClicking the Sign in with Social button.
UI Event: Push Sign InClicking the Sign in button.
UI Event: Auto Sign InAutomatic authentication.
UI Event: Game install window: Changed the installation pathChanging the installation path.
UI Event: Game install window: Changed the installation driveChanging the installation drive.
UI Event: Game install window: Not enough disk space for game installError installing the game: not enough disk space.

User authentication events

EventDescription
Launcher Login Event: Login finishSuccessful authentication.
Launcher Login Event: Login failedAuthentication attempt failed.
Launcher Login Event: Login social finishSuccessful social authentication.
Launcher Login Event: Login social failedSocial authentication failed.
Launcher Login Event: Login captcha openOpening CAPTCHA.
Launcher Login Event: Login privacy policy openOpening privacy policy.

Events of installing, launching, and uninstalling a game and redistributable packages

EventDescription
Game Installation Event: Game installation startGame installation started.
Game Installation Event: Game installation stoppedGame installation stopped.
Game Installation Event: Game installation finishedGame installation finished.
Game Installation Error: Game installation failedGame installation failed.
Game Installation Event: Game updating startGame updating started.
Game Installation Event: Game updating stoppedGame updating stopped.
Game Installation Event: Game updating finishedGame updating finished.
Game Installation Error: Game updating failedGame updating failed.
Game Installation Event: Game repairing startGame repairing started.
Game Installation Error: Game repairing failedGame repairing failed.
Game Installation Event: Game repairing stoppedGame repairing stopped.
Game Installation Event: Game repairing finishedGame repairing finished.
Game Uninstallation Event: Game uninstall startGame uninstallation started.
Game Uninstallation Event: Game uninstall finishedGame uninstallation finished.
Game Event: Game startGame started.
Game Event: Game stoppedGame stopped.
Game Error: Game crashedGame crashed.
Redist Event: Redist install startRedistributable packages installation started.
Redist Event: Redist install finishRedistributable packages installation finished.
Redist Error: Redist install failedRedistributable packages installation failed.

Error events when downloading, unpacking, and patching a game, and updating Launcher

EventDescription
Error: Extractor: Can't open fileError unpacking the game: can’t open the file.
Error: Extractor: Archive isn't supportedError unpacking the game: can’t open the archive.
Error: Extractor: Extraction exceptionError unpacking the game.
Error: CreateFileAction: Can't save file is already existError creating the file: the file already exists.
Error: CreateFileAction: Can't save filetError saving the file.
Error: DownloadAction: Network error, codeNetwork error downloading the game.
Error: TorrentDownloadAction: Network error, codeNetwork error downloading the game through the torrent.
Error: DownloadAction: Can't start download. Destination dir is undefinedError starting the download: the destination directory is not specified.
Error: ExtractAction: Unpacking errorError unpacking Launcher updates.
Error: CopyFileAction: Can't copy fileError copying the file.
Error: MoveFileAction: Can't move fileError moving the file.
Error: DeleteFileAction: Can't delete fileError deleting the file.
Error: CreateDirAction: Can't create directoryError creating a directory.
Error: PatchAction: Can't patch filesError patching files.
Error: InstallAction: Failed to startError starting game installation.
Error: CopyDirAction: Can't copy dirError copying the directory.
Error: MoveDirAction: Can't move directoryError moving the directory.
Error: RestartLauncherAction: Can't restart launcherError restarting Launcher.
Error: DeleteDirAction: Can't delete dirError deleting the directory.
Error: VerifyAction: Verify file finished with errorError verifying the file: the file was not verified.
Error: VerifyAction: Can't find patch rulesError verifying the file: error finding file verification rules.
Error: VerifyAction: Can't verify filesError starting verification.
Error: LauncherUpdater: Can't open fileError opening files during the Launcher update.
Error: LauncherUpdater: Can't extract archiveError unpacking an archive during the Launcher update.
Error: Steam: Overlay disabledError opening the Steam overlay.

Store events

EventDescription
Store event: Redeem key successfulKey successfully redeemed.
Store event: Redeem key failedKey redemption failed.
Store event: Buy the virtual itemBuying the virtual item.
Store event: Buy the gameBuying the game.

Who Can Use It

Partners who have already integrated Launcher.

How to Get It

Open the Config.json file and add the custom_analytics object. In this object, specify:

  • Url — the URL you want to receive events at;
  • sendIntervalMsec — the interval of sending events;
  • custom_fields — the array of custom fields and their values sent with the event (optional).

Example of the custom_analytics object:

Copy
Full screen
Small screen
"custom_analytics": {
  "Url": "endpoint_URL",
  "sendIntervalMsec": 2000,
  "custom_fields": [
    "custom_field1_name": "custom_field1_value",
    "custom_field2_name": "custom_field2_value",
  ]
}

Example of the event:

Copy
Full screen
Small screen
{
  "EntityType": "title",
  "EventId": "launcher1597240611",
  "EventName": "UI Event: Push Sign In",
  "Timestamp": "2020-08-12T15:56:51Z",
  "EventAttributes": "{\"SessionID\": \"138171e4426385405becd842f7265d7a746280ce1597240501\", \"UserId\": \"\"}",
  "ReceivedTimestamp": 1597240613.3814895
}