Skip to main content

Games International API

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

partner_id

string

yes

Your Besitos partner ID.

sub_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

country_codes

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 AU, CA, DE, FR, GB, IT, and ES.

device_platform

string

no*

Filter offers by device platform. Possible values are android, ios, or all. If not specified, android is used by default.

offer_id

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

country_code

string

Country code for which the offers are available. Uses ISO 3166-1 alpha-2 country codes. Supported values are AU, CA, DE, ES, FR, GB, IT, and US.

AU

country_name

string

Full country name corresponding to country_code.

Australia

Promotions

Available only when a promotion applies.

promotion_id

number

Unique identifier for the promotion. Use this value to associate an offer with a promotion through the offer's promotion_ids field.

3

name

string

Internal name of the promotion.

"Weekend Double Rewards"

type

string

The promotion type. Currently, reward_multiplier is the only supported value.

"reward_multiplier"

value

number

Reward multiplier applied to eligible reward. For example, a value of 2 doubles the reward, while 2.5 increases it to 2.5 times the original reward.

2

state

string

Current status of the promotion: live, upcoming, or ended.

live

reward_duration_mode

string

Determines how long the promotional reward applies. promo_window applies the boost only during the promotion window. install_duration continues the boost for eligible users who started the offer during the promotion, even after the promotion ends.

"promo_window"

included_goal_sections

string

Goal types eligible for the promotional reward. Values can include linear, turbo, and bonus. An empty array means the promotion applies to all goal types.

["turbo", "bonus"]

start_date

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.

"2026-08-22"

end_date

string

End date of the current promotion occurrence. A null value indicates an indefinite recurring promotion that continues until it is deactivated.

"2026-08-23"

badge_text

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.

"2× Rewards"

banner

object

color_theme

string

Determines the color used for the promotion banner. default uses the partner's configured theme color; custom uses the color specified in color.

"custom"

color

string

Custom color for the promotion banner in hexadecimal format. Used when color_theme is custom; otherwise, the value is null.

"#6C5CE7"

emoji

string

Emoji displayed in the promotion banner, if configured.

"🎉"

primary_text

string

Primary text displayed in the promotion banner. For an upcoming promotion, the announcement copy is used.

"Double Rewards!"

secondary_text

string

Secondary text displayed in the promotion banner. For an upcoming promotion, the announcement copy is used.

"This weekend only"

countdown

object

enabled

boolean

Indicates whether a countdown timer is enabled for the promotion banner.

true

target

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 null when the countdown is disabled, or the promotion has ended.

"2026-08-23T23:59:59+00:00"

seconds_remaining

number

Number of seconds remaining until the countdown target at the time of the response. The value is null when there is no countdown target.

51840

Offer

id

string

Unique identifier for the offer.

"TcC6HeBsCtiN"

bundle_id

string

Application bundle identifier for the game.

"air.com.buffalo_studios.newflashbingo"

image_text

string

Short promotional message displayed with the offer.

"Get ready to enter a world of addictive fun with Domino Dreams!"

title

string

Name of the offer.

"Domino Dreams"

image

string

The URL to the primary offer image.

See images for new image types.

https://cdn.kashkick.com/offers/btT5l9QCt0GJ.png

square_image

string

The URL to the square offer image.

See images for new image types.

https://cdn-staging.besitos.ai/offers/mh1666289595.png

large_image

string

The URL to the large offer image.

See images for new image types.

https://cdn.kashkick.com/offers/AR6vvdMe8XlH.png

images

object

Contains all image paths and dimensions available for the offer.

main_image

object

The main offer image, including its URL, dimensions, and aspect ratio.

large_image

object

The large offer image, including its URL, dimensions, and aspect ratio.

square_image

object

The square offer image, including its URL, dimensions, and aspect ratio.

widescreen_1220x610

object

The widescreen offer image at 1220 x 610 pixels, including its URL, dimensions, and aspect ratio.

widescreen_1280x735

object

The widescreen offer image at 1280 × 735 pixels, including its URL, dimensions, and aspect ratio.

portrait_460x1002

object

The portrait offer image at 460 × 1002 pixels, including its URL, dimensions, and aspect ratio.

portrait_573x1024

object

The portrait offer image at 573 × 1024 pixels, including its URL, dimensions, and aspect ratio.

retina_1080x1937

object

The high-resolution portrait offer image at 1080 × 1937 pixels, including its URL, dimensions, and aspect ratio.

landscape_1080x720

object

The landscape offer image at 1080 × 720 pixels, including its URL, dimensions, and aspect ratio.

card_text

string

Additional promotional text displayed on the offer card.

"29,576 New Players have earned $2,076,050+ by rolling the dice!"

amount

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 value.

4200

amount_currency

string

Currency symbol or currency name used for the amount value. Returns your configured currency or USD by default.

"coins"

cpi

number

Amount you (the partner) earn, in USD, when the offer is completed. This value corresponds to the payout field returned by the Conversions Data API.

5.2

url

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.
​
Supported query parameters:

  • sub_id - Optional, partner-defined sub ID.

  • partner_user_id - Required user ID the partner must populate when the user clicks the offer.

  • info - Optional, additional information to include with the postback, such as a click or session ID.

  • idfa - Optional advertiser ID for iOS.*

  • gaid - Optional Google advertising ID for Android.*

* idfa and gaid must be read from the user's device and appended to the redirect URL at click time.

description*

string

Detailed description of the offer.

"👑Welcome to Domino Dreams! Play this fun, free to play domino royal game created for Solitaire and Domino lovers and discover a new world in the most relaxing board game in the world! 👑🏰Solve challenging domino puzzles and help King Richard on his royal tour adventure! Just play and relax while you enjoy the game's art design.🏰Complete Level 250 in 10 days after installing to earn $10, and Level 500 in 15 days after installing to earn an additional $40 -- $50 in total. In-app purchases can enable you to complete the Levels faster! Note: Chargebacks, deleting the app, and/or skipping levels may lead to a reversal of a pending reward."

details*

string

Offer requirements, eligibility rules, and reward terms.

"General guidelines to complete the offer"

points

array

Key offer highlights to display as bullet points in the user interface. Each item contains a title attribute.

"points": [{

"title": "Players must win FIRST place to be eligible for rewards."

},{

"title": "Compete in multiplayer tournaments for cash prizes!"

},{

"title": "Enjoy competing against family and friends."

},{

"title": "Experience fair competition matched to your skill level."

},{

"title": "Reminder: You can earn on future challenges even if you miss an earlier goal."

}]

Goals

goal_id

string

Unique identifier for the goal.

"L7HmeCOmxpID_204"

amount

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 value.

8000

original_amount

number

Shows the original reward amount before the reward multiplier is applied. Available only when a promotion applies.

1000

is_boosted

boolean

Available and true only when the goal is boosted by a promotion.

true

text

string

Short description of the goal.

"Level 32 Completion"

days_left

number

Number of days from installation in which the goal must be completed. Returns null for installation goals.

11

goal_type

string

Goal completion type. linear goals must be completed in sequence, while non-linear goals can be completed in any order.

"linear" or "non-linear"

section

string

Timeline section where the goal is displayed. Possible values include:

  • "linear" goals must be completed in sequence

  • "Turbo" optional goals that require faster progression and in-app purchases

  • "Bonus" optional tasks that may require an in-app purchase

"linear", "turbo", or "bonus"

position

number

Position of the goal within the offer timeline.

13

Other offer details

budget_status

string

Current budget availability for the offer. Possible values are Active and Exhausted. When Exhausted, the offer is unavailable to new users until the budget resets.

Refresh every 1-2 minutes for the most current status.

"budget_status": "Exhausted"

remaining_budget

number

Remaining budget available for the current day. Returns null when the offer has no budget limit.

78.75

categories

array

Categories associated with the offer. Each item contains a name attribute.

"categories": [
{"name": "Simulation"
}]

state_filter

array

State availability rules for the offer. Includes a type and a list of state abbreviations in states.
​
​Type can be:

  • all - available in all states

  • include -available in listed states

  • exclude - not available in listed states

"type": "all", "states": []

or

"type": "include", "states": ["FL", "CA"]

or

"type": "exclude", "states": ["AZ", "MO"]

is_new

boolean

Indicates whether the offer was added within the last 14 days.

false

video_url

string

URL of the offer video. Returned only when video support is enabled.

thumbnail_url

string

URL of the offer video thumbnail image. Returned only when video support is enabled.

promotion_ids

number

The IDs from promotions[]. Present only when promotions apply.

device

string

Device platform supported by the offer. Possible values are android and ios.

"android"

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.

epc

number

Earnings Per Click is the average revenue generated per click.

.02

epi

number

Earnings Per Impression indicates the average revenue earned per impression.

1.98

roas_d0

number

Return on Ad Spend Day 0 measures the percentage of ad spend recovered within the first 24 hours of user acquisition.

50

roas_d7

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.

15

roas_d14

number

Return on Ad Spend Day 14 shows cumulative revenue after two weeks.

20

roas_d30

number

Return on Ad Spend Day 30 shows cumulative revenue after one month.

46

retention_rate_d1

number

The number of users who returned to the app exactly one day after install.

35

retention_rate_d7

number

The number of users who are still active 7 days after install.

27

retention_rate_d14

number

The number of users who are still active 14 days after install.

21

retention_rate_d30

number

The number of users who are still active 30 days after install.

15

Links

first

string

URL for the first page of results.

last

string

URL for the last page of results.

prev

string

URL for the previous page. Returns

null if no previous page exists.

next

string

URL for the next page. Returns

null if no next page exists.

Metadata

current_page

number

Current page number.

1

from, to

number

Index of the first item returned on the current page.

10
​

last_page

number

Total number of available pages.

13

links

array

Pagination link objects containing url, label, and active attributes. Returns an empty array if no links are available.

includes “url”, “label” and “active” attributes

path

string

Base URL for pagination.

per_page

number

Maximum number of items returned per page.

1000

total

number

Total number of items available across all pages.

2

For help, contact your Besitos Account Manager or our Implementation Team at [email protected] or via your project channel in Slack.

Did this answer your question?