Overview
API requests for managing game player data, including profile information, virtual currencies, statistics, custom metadata, inventory, and social interactions such as friends, groups, and segments.
OperationCode
| Name | Code | Description |
|---|---|---|
| Add Player Friend | addPlayerFriend | Send a friend request from one player to another. |
| Add Segment | addSegment | Assign a player to a specific segment for grouping or analysis. |
| Change Player Currency | changePlayerCurrency | Modify a player's virtual currency balance. |
| Change Player Statistics | changePlayerStatistics | Adjust one or more statistical values for the player. |
| Create Group | createGroup | Create a new player group with specified members. |
| Create Player Character | createPlayerCharacter | Initialize a new character associated with the player. |
| Create Player Item | createPlayerItem | Add a new item to the player’s inventory. |
| Get Avatar | getAvatar | Retrieve the player’s avatar image URL. |
| Get Country Code | getCountryCode | Get the country code associated with the player’s IP address. |
| Get Create Leaderboard | getCreateLeaderboard | Fetch data used to generate a leaderboard for player creation times. |
| Get Currency Leaderboard | getCurrencyLeaderboard | Retrieve a leaderboard based on players’ currency balances. |
| Get Currency Log | getCurrencyLog | View historical records of currency transactions for a player. |
| Get Custom Data | getCustomData | Retrieve custom key-value data stored for a player. |
| Get Display Name | getDisplayName | Retrieve the player's current display name. |
| Get Friend Statistics Leaderboard Around Player | getFriendStatisticsLeaderboardAroundPlayer | Get the leaderboard centered on the player's ranking among friends for a specific statistic. |
| Get Friend Statistics Leaderboard | getFriendStatisticsLeaderboard | Get the full leaderboard among a player’s friends for a given statistic. |
| Get Ip Address Create | getIpAddressCreate | Return the IP address used when the player's account was created. |
| Get Last Login Leaderboard | getLastLoginLeaderboard | Get a leaderboard sorted by the most recent player login times. |
| Get Online Status | getOnlineStatus | Check whether a specific player is currently online. |
| Get Player Ban | getPlayerBan | Retrieve ban status and details for a specific player. |
| Get Player Character | getPlayerCharacter | Get all characters created by a player. |
| Get Player Currency | getPlayerCurrency | Retrieve the current currency balances for a player. |
| Get Player Data | getPlayerData | Retrieve player-specific key-value data entries. |
| Get Player Friend | getPlayerFriend | Retrieve the player’s full friend list. |
| Get Player Group | getPlayerGroup | Get all groups that the player is currently a member of. |
| Get Player Information | getPlayerInformation | Fetch high-level metadata and profile information for a player. |
| Get Player Inventory | getPlayerInventory | Retrieve the player’s current inventory of items. |
| Get Player Statistics | getPlayerStatistics | Return a list of the player’s statistics and their values. |
| Get Players With Display Name | getPlayersWithDisplayName | Find players with an exact or partial match on display name. |
| Get Players With Segment | getPlayersWithSegment | Get all players who belong to a specific segment. |
| Get Players With Tag | getPlayersWithTag | List all players who have been assigned a specific tag. |
| Get Segment | getSegment | Retrieve a list of all available player segments. |
| Get Statistics Leaderboard Around Player | getStatisticsLeaderboardAroundPlayer | Get a leaderboard centered on the player’s position for a given statistic. |
| Get Statistics Leaderboard | getStatisticsLeaderboard | Retrieve the full leaderboard for a given statistic. |
| Get Statistics Log | getStatisticsLog | Get the full history of updates made to a player's statistics. |
| Get Tag | getTag | Return a list of all custom tags currently assigned to the player. |
| Get Ts Create | getTsCreate | Get the timestamp when the player’s account was created. |
| Get Ts Last Login | getTsLastLogin | Get the timestamp of the player's most recent login. |
| Join Group | joinGroup | Add a player to a group as a member. |
| Leave Group | leaveGroup | Remove a player from a group. |
| Remove Player Character | removePlayerCharacter | Delete a character previously created by the player. |
| Remove Player Friend | removePlayerFriend | Remove another player from the player’s friend list. |
| Remove Player Item | removePlayerItem | Delete an item from the player’s inventory. |
| Remove Segment | removeSegment | Remove the player from a previously assigned segment. |
| Remove Tag | removeTag | Delete a tag that was assigned to the player. |
| Set Avatar | setAvatar | Update the player’s avatar image. |
| Set Country Code | setCountryCode | Manually set the player’s country code. |
| Set Custom Data | setCustomData | Update or create key-value custom data entries for a player. |
| Set Display Name | setDisplayName | Change the player’s display name. |
| Set Player Ban | setPlayerBan | Apply a ban to a player with specific reason and duration. |
| Set Player Data | setPlayerData | Replace or modify structured player data. |
| Set Tag | setTag | Assign a custom tag to the player for classification or filtering. |