Games & Offers API
Learn more about the Games & Offers API
General idea
In case you want to have your own UI implementation, or already have an existing backend with other offers, we provide the offer API as a solution. There are two APIs available:
- The User Based Offer API: This API returns offers for a specific user ID and can be called on the client side or server side.
- The Static Offer API: This API returns a list of all available offers. You need to call this API on the server side. This allows you to add offers to your already existing inventory.
If you are unsure which API is the better fit for you, you can always contact your BitLabs account manager.
How to use the APIs effectively?
To deliver the best possible user experience, it’s important to make full use of certain API fields that help ensure clarity and transparency for your users. These fields play a key role in reducing user complaints and making it easier for users to understand their progress and any applicable requirements or restrictions.
Below is a list of API fields we consider essential for achieving this:
| Field Name | Description |
|---|---|
anchor | The anchor is the user-facing title of the offer. |
click_url | The URL the user needs to click on to start an offer and the tracking process. |
description | The offer description provides a general idea of what the offer entails. |
requirements | The requirements to complete this offer. |
things_to_know | Any additional information the user should be aware of regarding this offer. |
disclaimer | Disclaimer of the offer. |
pending_time | The time the reward is pending, if delayed crediting is enabled. |
session_hours | The amount of time the user has to progress and complete the offer. If the user progresses or completes the offer outside the given time, they won't be credited for it. |
support_url | URL to the support form to reach Prodege's support team. |
events.name | The name of the event, including a description of what the user has to do. |
events.points | The reward amount for the user. If you are not using points, any other reward should be displayed to the user. |
events.ttc_minutes | The time the user has to complete an event. If the user completes an event outside the given time, they won't be credited for this event. |
Troubleshooting Tracking Issues
Sometimes, during internal testing, installs or events may not be tracked correctly. This can occur due to several common reasons:
- The game was previously installed on your device, even if you're using a new user ID.
- The game hasn't been opened after installation.
- A VPN is active on your device.
- On iOS, iCloud Private Relay is enabled.
- On iOS, you didn’t allow App Tracking Transparency when launching the app.
- The click URL is being URL-encoded.
- Delayed crediting on our end is enabled (PENDING state).
- The IP address changed between the click and the first app open.
- The MMP or advertiser didn’t send the event. In this case, if none of these situations apply, please contact us so we can investigate further.
Updated 22 days ago
