API Reference
Start typing to search…

Retrieve achievements by their IDs

post https://us-central1-readysandbox.cloudfunctions.net/achievements-getByIds
Log in to see full request history
Body Params
ids
array of strings
required

Array of achievement IDs to retrieve

ids*
Responses

Response body
object
achievements
array of objects
achievements
object
string

Achievement document id. To trigger an achievement the id is needed.

appIds
array of strings
required

List of application ids where this achievement is used.

appIds*
string

Achievement request name. This value can be used to query or trigger achievements.

string

Achievement name. This value can be null or empty.

string

Achievement description. This value can be null or empty.

string

Defines who can set the achievement as completed: - client - the client and the server can set the achievement as completed. - server - only the server can set the achievement as completed.

client server

boolean

Should the achievement be claim manually to receive the rewards.

int32
Defaults to 1

Value which should be reached to complete the achievement. Default is 1.

completedAchievementsToUnlock
array of strings

Achievement ids which should be completed before this achievement can be triggered.

completedAchievementsToUnlock
boolean
Defaults to false

Can this achievement be applied multiple times to the same user account. Default is false.

string

If provided, the trigger for this achievement will work no more often than the specified cron string. Use https://crontab.guru/ to create cron settings. For example, if the value is 0 0 1 * *, the achievement can be triggered only once a day.

int64

Start time of the achievement in milliseconds since midnight, January 1, 1970 UTC.

int64

End time of the achievement in milliseconds since midnight, January 1, 1970 UTC.

string

Define cron value when the achievement should reset. This parameter is used to update the startTime and endTime values. Use https://crontab.guru/ to create cron settings.

rewards
array of objects

Achievement rewards ids and quantity rewards to add to users when the achievement is triggered.

rewards
object
string
required

The type of reward this achievement offers.
Supported reward types are:

  • currency - the reward is a quantity of currency coins. The name field is the name of the currency.
  • addGlobalCurrency - the reward is a quantity of global currency coins. The name field is the name of the currency.
  • addRDYXBasedOnUSDTGlobalCurrency - the reward is a quantity of RDYX based on the USDT global currency the user will get when completes the achievement. The name field is always USDT.
  • item_by_id - the reward is a quantity of a virtual items. The name field is the id of the virtual item.
  • progression - the reward is a quantity of progression. The name field is the id/name of the progression.
  • setLeaderboardScore - the reward is a quantity of leaderboard score to set. The name field is the id of the leaderboard.
  • addLeaderboardScore - the reward is a quantity of leaderboard score to add. The name field is the id of the leaderboard.
  • gamepass_by_id - the reward is a quantity of game passes to add. The name field is the id of the game pass.
  • gamepass_by_request_name - the reward is a quantity of game passes to add. The name field is the request name of the game pass.

currency addGlobalCurrency addRDYXBasedOnUSDTGlobalCurrency item_by_id progression setLeaderboardScore addLeaderboardScore gamepass_by_id gamepass_by_request_name

appIds
array of strings
required

The list of application IDs for which this achievement reward is applicable. This allows rewards to be scoped to specific applications within a developer's portfolio.

appIds*
string
required

The name of the reward. This could be the id of the virtual item, currency name, progression id, or leaderboard id.

int32
required

The quantity of the reward that will be given to the user upon completing the achievement. For "virtualItem" and "currency", it represents the number of items or coins rewarded. For "progression", it represents the increment value for the user's progression. For "setLeaderboardScore", it represents the score that will be set for the current user to the leaderboard. For "addLeaderboardScore", it represents the score that will be added for the current user to the leaderboard.

requiredToComplete
object

Requirements to complete the achievement. When the achievement is triggered, the requirements are checked.

string

Icon name of the achievement.

number | null
1 to 3650
Defaults to null

The number of days after which the achievement will reset. This field is relevant only if the achievement is repeatable. Default is null. Use it for daily, weekly, or monthly achievements. The value should be greater than 0. Every 0:00 UTC the user-achievements with this field will reset.

properties
array of objects

List of properties for the achievement.

properties
object
array of strings | null
appIds
string | null
tags
array of strings

List of tags to filter the achievements. Used for categorization.

tags
int64

Time when the achievement was created in milliseconds since midnight, January 1, 1970 UTC. This field is automatically populated by the backend.

int64

Time when the achievement was updated in milliseconds since midnight, January 1, 1970 UTC. This field is automatically populated by the backend.

string

Creator user id. This field is automatically populated by the backend.

string

Updater user id. This field is automatically populated by the backend.

400

Bad request, possibly due to missing or invalid parameters

Updated about 2 months ago

Did this page help you?
Language
URL

Updated about 2 months ago

Did this page help you?