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.
What are the minimum requirements to use the APIs?
We require ALL partners to clearly and conspicuously display to users the information returned by certain API fields. This provides clarity and transparency for users, and limits future user complaints, by communicating all applicable offer requirements, conditions, and restrictions up-front.
Below is a list of the API fields we require. Except where an alternative is expressly identified with an asterisk (*), you must display each of these fields:
| 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 | Provides a general idea of what the offer entails. |
requirements | The specific requirements to complete this offer. |
things_to_know | A summary of key information that the user should be aware of regarding this offer. |
disclaimer | Detailed terms and conditions regarding the offer. |
pending_time | The length of time that rewards will be pending, if delayed crediting is enabled. |
session_hours | The maximum amount of time that the user has to complete the entire offer. If the user completes any event outside this time period, they won't be credited. Note that individual events can have shorter applicable times-to-complete (TTC) in events.ttc_minutes. |
support_url | URL to the support form to reach Prodege's support team. *If you do not wish for Prodege to provide first-line support for offers on your platform, you can replace this with another contact method. |
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 do not use points, another applicable reward may be displayed to the user. |
events.ttc_minutes | The time the user has to complete each individual 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 13 days ago
