GearN Server | Rest Api references

Overview

API endpoints for managing master player accounts, linked services, player metadata, statistics, push notifications, segmentation, and leaderboard analytics.

OperationCode

Name	Code	Description
Add Push Notification	addPushNotification	Register a new push notification token for the player.
Add Segment	addSegment	Assign the player to a specific segment for targeting or analysis.
Change Account Password	changeAccountPassword	Update the player's account password using the current password.
Change Player Currency	changePlayerCurrency	Modify the player's virtual currency balance.
Change Player Statistics	changePlayerStatistics	Update the values of one or more player statistics.
Get Avatar	getAvatar	Retrieve the player's avatar.
Get Country Code	getCountryCode	Retrieve the player's countrycode.
Get Create Leaderboard	getCreateLeaderboard	Retrieve leaderboard data based on createl.
Get Currency Leaderboard	getCurrencyLeaderboard	Retrieve leaderboard data based on currencyl.
Get Currency Log	getCurrencyLog	Fetch the player's currency transaction history.
Get Custom Data	getCustomData	Retrieve the player's customdata.
Get Display Name	getDisplayName	Retrieve the player's displayname.
Get Email	getEmail	Retrieve the player's email.
Get External	getExternal	Retrieve the player's external.
Get Ip Address Create	getIpAddressCreate	Retrieve the player's ipaddresscreate.
Get Last Login Leaderboard	getLastLoginLeaderboard	Retrieve leaderboard data based on lastloginl.
Get Player Ban	getPlayerBan	Retrieve the player's playerban.
Get Player Currency	getPlayerCurrency	Retrieve the player's playercurrency.
Get Player Data	getPlayerData	Fetch custom key-value data stored in the player's profile.
Get Player Information	getPlayerInformation	Retrieve the full profile and metadata of a player.
Get Player Statistics	getPlayerStatistics	Retrieve the player's playerstatistics.
Get Players With Apple	getPlayersWithApple	Retrieve all master players associated with Apple.
Get Players With Display Name	getPlayersWithDisplayName	Retrieve all master players associated with DisplayName.
Get Players With Facebook	getPlayersWithFacebook	Retrieve all master players associated with Facebook.
Get Players With Game Center	getPlayersWithGameCenter	Retrieve all master players associated with GameCenter.
Get Players With Generic Service	getPlayersWithGenericService	Retrieve all master players associated with GenericService.
Get Players With Google Play Game Service	getPlayersWithGooglePlayGameService	Retrieve all master players associated with GooglePlayGameService.
Get Players With Google	getPlayersWithGoogle	Retrieve all master players associated with Google.
Get Players With Segment	getPlayersWithSegment	Retrieve all master players associated with Segment.
Get Players With Tag	getPlayersWithTag	Retrieve all master players associated with Tag.
Get Push Notification	getPushNotification	Retrieve the player's pushnotification.
Get Segment	getSegment	Retrieve segment details associated with the player.
Get Statistics Leaderboard Around Player	getStatisticsLeaderboardAroundPlayer	Retrieve leaderboard data based on statisticsleaderboardar.
Get Statistics Leaderboard	getStatisticsLeaderboard	Retrieve leaderboard rankings based on player statistics.
Get Statistics Log	getStatisticsLog	Fetch historical log of changes made to the player's statistics.
Get Tag	getTag	Return a list of tags assigned to the player.
Get Ts Create	getTsCreate	Retrieve the player's tscreate.
Get Ts Last Login	getTsLastLogin	Retrieve the player's tslastlogin.
Link Account	linkAccount	Link the player's account to a account identifier.
Link Android Device Id	linkAndroidDeviceId	Associate the player's account with a device-specific Android ID.
Link Apple	linkApple	Link the player's account to an Apple Game Center profile.
Link Custom Device Id	linkCustomDeviceId	Link the player's account to a custom identifier.
Link Custom Id	linkCustomId	Link a custom identifier to the player's account.
Link Editor Device Id	linkEditorDeviceId	Link the player's account to a editor identifier.
Link Facebook	linkFacebook	Link the player's account to a Facebook profile.
Link Game Center	linkGameCenter	Link the player's account to a gamecenter identifier.
Link Generic Service	linkGenericService	Link the player's account to a genericservice identifier.
Link Google Play Game Service	linkGooglePlayGameService	Link the player's account to Google Play Game Services.
Link Google	linkGoogle	Link the player's account to a Google account.
Linki OSDevice Id	linkiOSDeviceId	Link the player's account to a ios identifier.
Link Linux Device Id	linkLinuxDeviceId	Link the player's account to a linux identifier.
Link Mac OSDevice Id	linkMacOSDeviceId	Link the player's account to a macos identifier.
Link Windows Device Id	linkWindowsDeviceId	Link the player's account to a windows identifier.
Link Windows Phone Device Id	linkWindowsPhoneDeviceId	Link the player's account to a windowsphone identifier.
Remove Push Notification	removePushNotification	Delete the registered push notification token from the player's profile.
Remove Segment	removeSegment	Remove the player from a previously assigned segment.
Remove Tag	removeTag	Delete a specific tag from the player's metadata.
Reset Account Password	resetAccountPassword	Reset the player's accountpassword.
Send Email	sendEmail	Send a email to the player.
Send Push Notification	sendPushNotification	Send a push notification message to the player.
Send Socket Operation Event	sendSocketOperationEvent	Send a socketoperationevent to the player.
Set Avatar	setAvatar	Update the player's avatar.
Set Country Code	setCountryCode	Update the player's countrycode.
Set Custom Data	setCustomData	Update the player's customdata.
Set Display Name	setDisplayName	Update the player's displayname.
Set Email	setEmail	Update the player's email.
Set Player Ban	setPlayerBan	Update the player's playerban.
Set Player Data	setPlayerData	Set or update key-value pairs in the player's custom data store.
Set Tag	setTag	Update the player's tag.
Set Ts Last Login	setTsLastLogin	Update the player's tslastlogin.
Unlink Account	unlinkAccount	Unlink the player's account account.
Unlink Android Device Id	unlinkAndroidDeviceId	Remove the association between the player's account and Android device ID.
Unlink Apple	unlinkApple	Remove the link between the player's account and their Apple ID.
Unlink Custom Device Id	unlinkCustomDeviceId	Unlink the player's custom account.
Unlink Custom Id	unlinkCustomId	Unlink a previously registered custom ID from the player's account.
Unlink Editor Device Id	unlinkEditorDeviceId	Unlink the player's editor account.
Unlink Facebook	unlinkFacebook	Unlink the player's Facebook profile from their account.
Unlink Game Center	unlinkGameCenter	Unlink the player's gamecenter account.
Unlink Generic Service	unlinkGenericService	Unlink the player's genericservice account.
Unlink Google Play Game Service	unlinkGooglePlayGameService	Unlink the player's account from Google Play Game Services.
Unlink Google	unlinkGoogle	Unlink the player's Google account from their profile.
Unlinki OSDevice Id	unlinkiOSDeviceId	Unlink the player's ios account.
Unlink Linux Device Id	unlinkLinuxDeviceId	Unlink the player's linux account.
Unlink Mac OSDevice Id	unlinkMacOSDeviceId	Unlink the player's macos account.
Unlink Windows Device Id	unlinkWindowsDeviceId	Unlink the player's windows account.
Unlink Windows Phone Device Id	unlinkWindowsPhoneDeviceId	Unlink the player's windowsphone account.