The Games International API provides the full catalog of game offers across all supported countries and device platforms, delivered in a single API call, unlike the Games API, which requires multiple calls.
This API is designed for partners with global audiences who want full control over how offers are sorted, filtered, and displayed.
Although this API gives you greater flexibility, it also requires more management effort. For example, you will need to regularly check the budget_status attribute for each offer to ensure you’re displaying only offers with available funds. You are also responsible for providing the appropriate country_codes requesting offer data, and filtering the response by state_filter to show offers only in eligible states.
Note: You can use APIs with our iFrame, but not with our Wallet solution.
Endpoint
Before you attempt to connect, complete the steps in Prepare to Connect to Besitos APIs.
Endpoint URL | https://wall.besitos.ai/data/partner/country-offers/{partner_id}https://wall.besitos.ai/data/partner/country-offers/{partner_id}/{sub_id} |
HTTP method | GET |
Refresh rate | 5 minutes |
We recommend refreshing the API periodically to keep your list of offers up to date.
Path Parameters
If you segment users in your database, this endpoint can include the optional sub_ID parameter. Learn more about user segmentation.
Path parameter | Data type | Required | Description |
| string | yes | Your Besitos partner ID. |
| string | no | Identifier used to group or track users within your system, such as a segment, campaign, or traffic source. Maximum 50 characters. |
Query Parameters
Query parameter | Data type | Required | Description |
| string | no* | Filter offers by country. Uses ISO 3166-1 alpha-2 country codes. If not specified, it returns only US offers. Supported values are |
| string | no* | Filter offers by device platform. Possible values are |
| string | no | Filter results by offer ID. If not specified, it returns all available game offers. |
*Note that country_codes is required to return all offers for the countries you support, and that device_platform=all is required to return offers for all supported platforms.
Examples
Request
GET https://wall.besitos.ai/data/partner/country-offers/CwI606dZ/67890?country_codes=US,CA,AU
Response
See our Postman Collection for a response sample.
Response Attributes
Attributes with a * must be displayed for users because they identify key earning requirements, such as operating system limitations and the number of days a user has to complete the offer.
Attributes | Data Type | Description | Example |
Data |
|
|
|
| string | Country code for which the offers are available. Uses ISO 3166-1 alpha-2 country codes. Supported values are |
|
| string | Full country name corresponding to |
|
Promotions |
| Available only when a promotion applies. |
|
| number | Unique identifier for the promotion. Use this value to associate an offer with a promotion through the offer's | |
| string | Internal name of the promotion. |
|
| string | The promotion type. Currently, |
|
| number | Reward multiplier applied to eligible reward. For example, a value of |
|
| string | Current status of the promotion: |
|
| string | Determines how long the promotional reward applies. |
|
| string | Goal types eligible for the promotional reward. Values can include |
|
| datetime/string | Start date of the current or next promotion occurrence. For recurring promotions, this reflects the applicable occurrence rather than the original promotion start date. |
|
| string | End date of the current promotion occurrence. A |
|
| string | Text displayed on the offer card badge to indicate the promotional reward. For ended promotions, the badge text indicates that the reward was earned. |
|
| object |
|
|
| string | Determines the color used for the promotion banner. |
|
| string | Custom color for the promotion banner in hexadecimal format. Used when |
|
| string | Emoji displayed in the promotion banner, if configured. |
|
| string | Primary text displayed in the promotion banner. For an upcoming promotion, the announcement copy is used. |
|
| string | Secondary text displayed in the promotion banner. For an upcoming promotion, the announcement copy is used. |
|
| object |
|
|
| boolean | Indicates whether a countdown timer is enabled for the promotion banner. | |
| string | Date and time the countdown timer is counting toward. For a live promotion, this is the end of the current occurrence. For an upcoming promotion, the start of the next occurrence. The value is |
|
| number | Number of seconds remaining until the countdown target at the time of the response. The value is |
|
Offer |
|
|
|
| string | Unique identifier for the offer. |
|
| string | Application bundle identifier for the game. |
|
| string | Short promotional message displayed with the offer. |
|
| string | Name of the offer. |
|
| string | The URL to the primary offer image. See |
|
| string | The URL to the square offer image. See |
|
| string | The URL to the large offer image. See |
|
| object | Contains all image paths and dimensions available for the offer. |
|
| object | The main offer image, including its URL, dimensions, and aspect ratio. |
|
| object | The large offer image, including its URL, dimensions, and aspect ratio. |
|
| object | The square offer image, including its URL, dimensions, and aspect ratio. |
|
| object | The widescreen offer image at 1220 x 610 pixels, including its URL, dimensions, and aspect ratio. |
|
| object | The widescreen offer image at 1280 × 735 pixels, including its URL, dimensions, and aspect ratio. |
|
| object | The portrait offer image at 460 × 1002 pixels, including its URL, dimensions, and aspect ratio. |
|
| object | The portrait offer image at 573 × 1024 pixels, including its URL, dimensions, and aspect ratio. |
|
| object | The high-resolution portrait offer image at 1080 × 1937 pixels, including its URL, dimensions, and aspect ratio. |
|
| object | The landscape offer image at 1080 × 720 pixels, including its URL, dimensions, and aspect ratio. |
|
| string | Additional promotional text displayed on the offer card. |
|
| number | Reward amount the user can earn for completing the offer. If a custom currency is configured, the value is returned in that currency; otherwise, it is returned in USD.
When a promotion applies, this value is precalculated using the reward multiplier in |
|
| string | Currency symbol or currency name used for the |
|
| number | Amount you (the partner) earn, in USD, when the offer is completed. This value corresponds to the |
|
| string | Tracking URL used to direct users to the offer. You can reuse a previously returned URL, even if it changes in a later API response; however, refresh the API to check budget status and offer availability.
* | |
| string | Detailed description of the offer. |
|
| string | Offer requirements, eligibility rules, and reward terms. |
|
| array | Key offer highlights to display as bullet points in the user interface. Each item contains a |
|
Goals |
|
|
|
| string | Unique identifier for the goal. |
|
| number | Reward amount the user earns upon completing the goal. If a custom currency is configured, the value is returned in that currency; otherwise, it is returned in USD.
When a promotion applies, this value is precalculated using the reward multiplier in |
|
| number | Shows the original reward amount before the reward multiplier is applied. Available only when a promotion applies. |
|
| boolean | Available and | |
| string | Short description of the goal. |
|
| number | Number of days from installation in which the goal must be completed. Returns |
|
| string | Goal completion type. |
|
| string | Timeline section where the goal is displayed. Possible values include:
|
|
| number | Position of the goal within the offer timeline. |
|
Other offer details |
|
|
|
| string | Current budget availability for the offer. Possible values are
Refresh every 1-2 minutes for the most current status. |
|
| number | Remaining budget available for the current day. Returns |
|
| array | Categories associated with the offer. Each item contains a |
|
| array | State availability rules for the offer. Includes a
|
or
or
|
| boolean | Indicates whether the offer was added within the last 14 days. |
|
| string | URL of the offer video. Returned only when video support is enabled. | |
| string | URL of the offer video thumbnail image. Returned only when video support is enabled. | |
| number | The IDs from |
|
| string | Device platform supported by the offer. Possible values are |
|
Stats |
| Stats are benchmark values reflecting expected performance based on aggregated partner data, but may not mirror your platform's offer performance due to differences in audience, targeting, and engagement. |
|
| number | Earnings Per Click is the average revenue generated per click.
|
|
| number | Earnings Per Impression indicates the average revenue earned per impression. |
|
| number | Return on Ad Spend Day 0 measures the percentage of ad spend recovered within the first 24 hours of user acquisition. |
|
| number | Return on Ad Spend Day 7 is the total revenue generated by a group of users on their 7th day, divided by the cost to acquire them. |
|
| number | Return on Ad Spend Day 14 shows cumulative revenue after two weeks. |
|
| number | Return on Ad Spend Day 30 shows cumulative revenue after one month. |
|
| number | The number of users who returned to the app exactly one day after install. |
|
| number | The number of users who are still active 7 days after install. |
|
| number | The number of users who are still active 14 days after install. |
|
| number | The number of users who are still active 30 days after install. |
|
Links |
|
|
|
| string | URL for the first page of results. | |
| string | URL for the last page of results. | |
| string | URL for the previous page. Returns
| |
| string | URL for the next page. Returns
| |
Metadata |
|
|
|
| number | Current page number. |
|
| number | Index of the first item returned on the current page. |
|
| number | Total number of available pages. |
|
| array | Pagination link objects containing | includes |
| string | Base URL for pagination. | |
| number | Maximum number of items returned per page. |
|
| number | Total number of items available across all pages. |
|
For help, contact your Besitos Account Manager or our Implementation Team at [email protected] or via your project channel in Slack.
