Challenges API

Challenges are created for the game developers. They cannot be created from Monetizr Console. Challenges are specifically designed for a game and they are sponsored by a Brand. we have included sample challenge in Monetizr Console for development purposes.

Acquire the API key and add challenges

To acquire your own unique access key, you will need to create an account Creating account. After you have created an account and authorized, you can navigate to Challenges section. In the Catalog you will see all of the prepared development challenges that can be added to your game. When you click on Add to my button, the challenge will included in your list of available challenges.

After authorization, navigate to challenges section and view available challenges.After authorization, navigate to challenges section and view available challenges.

After authorization, navigate to challenges section and view available challenges.

When the challenge has been attached to your account, you can start using the Challenges API. To find the API key and Challenge ID, navigate to My Challenges section and open the challenge. Under the For developer tab you will find your API Key and Challenge ID. The Challenge ID is used as an identificator in Challenges API.

You can find API key and Challenge ID under For developer tab in My Challenges sectionYou can find API key and Challenge ID under For developer tab in My Challenges section

You can find API key and Challenge ID under For developer tab in My Challenges section

This API key can be used for the challenges as well as for Offers and Giveaways.

However in order to start using the challenges in production, you will have to contact Monetizr to onboard your game and.

Request challenges from the API

The challenges data can be acquired through API Challenges list or through Challenge details.

The challenges details are described in the API reference documentation.

Request player progress for a challenge

The challenge progress returns the progress in % (scale 1-100) format based on your status updates for a specific player-id. The challenges progress can be acquired through API Challenge progress ]

Request challenge assets

Assets are 2D and 3D objects added to the challenge. Assets are available through API Challenge assets endpoint. The assets are available when you request Challenges list and Challenge details as well. Assets are distribute using global CDN for faster delivery.

Request one assets

Assets are available through API Challenge assets endpoint. You can request a single asset using its ID.

Update challenge status

Challenge requires status updates, when a player accomplishes a milestone for the challenge you have to send a request to the Challenge status endpoint and update the progress for a specific player.

Claim challenge

Challenge can be claimed when the player has accomplished the competition. To claim the challenge you have to send a request to the Challenge claim endpoint.


Did this page help you?