Campaigns API

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

Acquire the API key and add campaign

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 Campaigns section. In the Catalog you will see all of the prepared development campaigns that can be added to your game. When you click on Add to my button, the campaign will included in your list of available campaigns.

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

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

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

You can find API key and Campaign ID under For developer tab in My Campaigns sectionYou can find API key and Campaign ID under For developer tab in My Campaigns section

You can find API key and Campaign ID under For developer tab in My Campaigns section

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

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

Request campaigns from the API

The campaigns data can be acquired through API Campaigns list or through Campaign details.

The campaign details are described in the API reference documentation.

Request player progress for a campaign

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

Request campaign assets

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

Request one assets

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

Update campaign status

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

Claim campaign

Campaign can be claimed when the player has accomplished the competition. To claim the campaign reward you have to send a request to the Campaign claim endpoint.


Did this page help you?