Get Offers for Publishers
Returns a list of offers that are available for all users. Note that this is not customized for any user.
Query parameters
-
limit
integer Limit the number of results to X.
Default value is
2000. -
skip
integer Skips the first X number of results.
Default value is
0. -
countries
array[string] Filter by specific countries using ISO country codes.
Format of each should match the following pattern:
^[a-z]{2}$. -
offer_ids
string Filter by specific offers. Accepts a list of comma separated offer IDs.
-
pay_min
string Filter by offers above a minimum payout. Values are in USD.
-
min_epc
string Filter by offers above a minimum EPC. Values are in USD.
-
categories
string Filter by offers in certain categories. Accepts a comma separated list of category IDs.
-
platforms
string Filter by specific platforms. Accepts a list of comma separated platforms from desktop, smartphone, tablet.
-
order_by
string Order results by either payout, epc, or id(offer id) in descending order. payout is calculated as the maximum payout from the offer's events. Default is epc.
Values are
payout,epc, orid.
GET
/v2/publishers/offers
curl \
--request GET 'https://api.bitlabs.ai/v2/publishers/offers' \
--header "X-S2S-Token: $API_KEY"
Response examples (200)
{
"data": {
"offers": [
{
"id": 42,
"name": "Final Fantasy XV iPhone CPE (US) (Incentive)",
"anchor": "Final Fantasy XV",
"country_stats": [
{
"country_code": "US",
"mobile_rank": 1,
"desktop_rank": 422
}
],
"description": "Be the hero of your own Final Fantasy XV adventure in the brand new mobile strategy game Final Fantasy XV!",
"requirements": "Install and Reach Citadel level 10.",
"things_to_know": [
"Must be a UK resident.",
"Award will pend for 30 days."
],
"disclaimer": "Must be a UK resident. ${currencyname} will appear as Pending for 30 days. This offer is presented to you by ${sitename} on behalf of a third party merchant. ${sitename} has not evaluated and does not endorse Merchant's views, policies, products or services.",
"pending_time": 12,
"translations": {
"additionalProperty1": {
"anchor": "Final Fantasy XV",
"description": "Sei der Held deines eigenen Final Fantasy XV Abenteuers im brandneuen mobilen Strategiespiel Final Fantasy XV!",
"requirements": "Installieren und Erreichen der Zitadellebene 10!"
},
"additionalProperty2": {
"anchor": "Final Fantasy XV",
"description": "Sei der Held deines eigenen Final Fantasy XV Abenteuers im brandneuen mobilen Strategiespiel Final Fantasy XV!",
"requirements": "Installieren und Erreichen der Zitadellebene 10!"
}
},
"device_targeting": {
"browsers": [
{
"name": "android",
"min_version": "4.4",
"max_version": "string"
}
],
"operating_systems": [
{
"name": "android",
"min_version": "4.4",
"max_version": "string"
}
],
"devices": [
{
"name": "android",
"min_version": "4.4",
"max_version": "string"
}
],
"platforms": [
{
"name": "android",
"min_version": "4.4",
"max_version": "string"
}
]
},
"geo_targeting": {
"countries": [
{
"country_code": "US",
"geoname_id": 5883102,
"name": "Alberta",
"code": "T1X 0L3"
}
],
"states": [
{
"country_code": "US",
"geoname_id": 5883102,
"name": "Alberta",
"code": "T1X 0L3"
}
],
"cities": [
{
"country_code": "US",
"geoname_id": 5883102,
"name": "Alberta",
"code": "T1X 0L3"
}
],
"postal_codes": [
{
"country_code": "US",
"geoname_id": 5883102,
"name": "Alberta",
"code": "T1X 0L3"
}
]
},
"icon": "https://main-p.agmcdn.com/offers/1564507470875.gif",
"epc": "string",
"categories": [
"iPhone"
],
"events": [
{
"id": "a9bf882a-5e06-49de-8cf7-a708ac653636",
"name": "install app",
"payout_type": "flat",
"payout": "1.30",
"is_cpc": true,
"multiple_conversions_allowed": true,
"points": "130.12",
"promotional_points": "150.29",
"multiple_conversions_rules": {
"rule_type": "unlimited",
"x_conversions": 1,
"every_y_seconds": 60
},
"type_id": 42,
"translations": {
"additionalProperty1": {
"name": "App installieren"
},
"additionalProperty2": {
"name": "App installieren"
}
}
}
],
"click_url": "https://bitlabs.link/vc/nQ/offers/100677?s1=",
"support_url": "https://wall.adgaterewards.com/offer/contact/nQ/100677?s1=",
"preview_url": "https://itunes.apple.com/app/final-fantasy-xv-a-new-empire/id1186994231?mt=8",
"app_metadata": {
"app_id": "com.google.android.youtube",
"categories": [
"Entertainment",
"Video Players & Editors"
],
"screenshot_urls": [
"https://lh3.googleusercontent.com/...",
"https://lh3.googleusercontent.com/..."
],
"video_urls": [
"https://www.youtube.com/watch?v=...",
"https://www.youtube.com/watch?v=..."
]
},
"is_game": true,
"product_id": "string",
"product_name": "string",
"is_sensitive": true,
"advertiser_id": 234567890,
"total_points": 1000,
"total_promotional_points": 100,
"session_hours": 24,
"demographic_targeting": {
"age": {
"exclude": true,
"unknown_allowed": true,
"options": [
{
"min_age": 42,
"max_age": 42
}
]
},
"gender": {
"exclude": true,
"unknown_allowed": true,
"options": [
"string"
]
}
},
"lowest_cap_left": 150,
"arpu_goals": [
{
"day": 1,
"goal": "2.40"
},
{
"day": 7,
"goal": "8.49"
}
]
}
]
}
}