Static Offer API
General Concept
The static offer API is designed to be called by a backend/server. This API returns you the unfiltered inventory we have available for you. The feed can be used to extend your existing offer inventory or build your own offer system.
It is to be noted that the static offer API was not designed to be used in combination with any of the user-based offer APIs that we provide.
Target Group or Use Case: Use this API if you want to grab our inventory to insert the offers in your existing offer management system.
Calling the API
You have to enable Offers for the App via our Publisher Dashboard
By calling the Get Offers for Publishers Endpoint, you will get the full inventory of offers available in the BitLabs network.
Example Response
{
"data": {
"offers": [
{
"anchor": "Puzzles and Chaos",
"categories": [
"CPE",
"Free",
"iPad",
"iPhone"
],
"click_url": "https://bitlabs.link/vc/naeXr2c/offers/805886?source_type=offer_api&s1=",
"country_stats": [
{
"country_code": "US",
"desktop_rank": 6,
"mobile_rank": 4
}
],
"description": "Puzzles & Chaos is a match-3 fantasy strategy game that tells an ancient legend of a Frozen Land.",
"device_targeting": {
"browsers": [],
"devices": [],
"operating_systems": [
{
"min_version": "15.0",
"name": "ios"
}
],
"platforms": [
{
"name": "smartphone"
},
{
"name": "tablet"
}
]
},
"epc": "12.77",
"events": [
{
"id": "769510e4-79b8-11ee-8516-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Install",
"payout": "0",
"payout_type": "flat",
"points": "0"
},
{
"id": "76951a26-79b8-11ee-a650-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Log In",
"payout": "8",
"payout_type": "flat",
"points": "0"
},
{
"id": "7695217e-79b8-11ee-acbe-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Reach Citadel 6",
"payout": "1.75",
"payout_type": "flat",
"points": "3500"
},
{
"id": "769528a4-79b8-11ee-8340-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Reach Citadel 11",
"payout": "5",
"payout_type": "flat",
"points": "15000"
},
{
"id": "76952fe8-79b8-11ee-bd6b-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Reach Citadel 16",
"payout": "15",
"payout_type": "flat",
"points": "30000"
},
{
"id": "76953736-79b8-11ee-83ec-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Reach Citadel 23",
"payout": "60",
"payout_type": "flat",
"points": "100000"
},
{
"id": "76953eac-79b8-11ee-ae8a-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Reach Citadel 30",
"payout": "125",
"payout_type": "flat",
"points": "200000"
},
{
"id": "8a1736d2-d28d-11ee-a1c4-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Reach Citadel 2 & Purchase Mythic Hero SAYA",
"payout": "4",
"payout_type": "flat",
"points": "8000"
},
{
"id": "8a177098-d28d-11ee-98a9-069eb31df495",
"is_cpc": false,
"multiple_conversions_allowed": false,
"name": "Purchase Carvell Pack $49.99",
"payout": "37.5",
"payout_type": "flat",
"points": "50000"
}
],
"geo_targeting": {
"cities": [],
"countries": [
{
"country_code": "US"
}
],
"postal_codes": [],
"states": []
},
"icon": "https://main-p.agmcdn.com/offers/805886-yckjRD7I.jpg",
"id": 805886,
"name": "Puzzles and Chaos iOS (US) (Incentive)",
"pending_time": 10080,
"preview_url": "https://apps.apple.com/nz/app/puzzles-chaos-frozen-castle/id6446389130",
"requirements": "Reach the various Castle levels within 30 days. New users only. You must click “Allow” if tracking permission is requested within the app. Confirms Instantly",
"support_url": "https://wall.adgaterewards.com/offer/contact/naeXr2c/805886&s1=",
"translations": null
}
]
}
}
Categories
| Category ID | Category Name |
|---|---|
| 1 | Android |
| 2 | Downloads |
| 3 | Email Submits |
| 4 | Free |
| 10 | iPad |
| 11 | iPhone |
| 12 | Lead Gen |
| 13 | Credit Card Required |
| 14 | Mobile Subscription |
| 16 | Surveys |
| 17 | Videos |
| 18 | CPC |
| 19 | Pay Per Call |
| 20 | Cash Back |
| 21 | CPI |
| 22 | CPE |
| 23 | CPA |
Response Parameters
| Key Name | Description |
|---|---|
| id | BitLabs offer id. |
| name | BitLabs's internal offer name, not to be displayed to end-users. |
| anchor | Offer title as shown to the end-user. |
| country_stats | Mobile and desktop ranks that indicate how well the offer performs compared to other offers within the same country. If API options are provided that filter the results, such as categories or platform, the ranks are calculated within the filtered result set. Note: the ranking algorithm is subject to change in the future. Please allow for gaps in the numeric ranks. |
| description | Offer description. |
| requirements | Offer requirements. The user must complete these requirements in order to convert. |
| translations | Available translations for the offer anchor, description, and requirements. |
| device_targeting | |
| device_targeting.browsers[].name | If present, the offer requires one of the specified browsers. Possible values are: chrome, firefox, safari, edge, internet explorer, chrome mobile, mobile safari (More values may be added in the future) |
| device_targeting.platforms[].name | If present, the offer requires one of the specified platforms. Possible values are: smartphone, tablet, desktop (More values may be added in the future) |
| device_targeting.devices[].name | If present, the offer requires one of the specified devices. Possible values are: iphone, ipad (More values may be added in the future) |
| device_targeting.operating_systems[].name | If present, the offer requires one of the specified operating systems. Possible values are: windows, mac os, ios, android (More values may be added in the future) |
| device_targeting.operating_systems[].min_version | Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null. |
| device_targeting.operating_systems[].max_version | Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null. |
| geo_targeting | |
| geo_targeting.countries[].country_code | The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use "GB" for the UK. |
| geo_targeting.states[].geoname_id | The states/regions that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from. |
| geo_targeting.states[].name | The name of the state/region as provided by Geonames. |
| geo_targeting.cities[].geoname_id | The cities that the offer is limited to, provided by the geoname ID. |
| geo_targeting.cities[].name | The name of the city as provided by Geonames. |
| geo_targeting.postal_codes[].code | The postal code the offer is limited to. |
| icon | Offer's icon |
| epc | Network-wide EPCs |
| categories | An array of offer categories (listed above) |
| events | An array of offer events. |
| event.id | UUID of the event |
| event.name | Event title |
| event.payout_type | One of "flat" or "dynamic". Flat payouts don't change. Dynamic payouts vary. Only 'flat' events are served at the moment. |
| event.payout | The dollar amount. |
| event.is_cpc | Boolean. Indicates if the offer event is CPC (cost-per-click). |
| event.multiple_conversions_allowed | Boolean. Indicates if the offer event allows multiple conversions for a single user (IP), according to the rules specified in "multiple_conversions_rules". |
| event.multiple_conversions_rules | Only present if "multiple_conversions_allowed" is true. It is an object with the following values: rule_type: Can be one of "UNLIMITED" or "INTERVAL". "UNLIMITED" means that the offer event can be completed an indefinite amount of times without time limit. "INTERVAL" means the offer event can be completed a certain amount of times in a given amount of time, in the format "allow X conversions every Y seconds". x_conversions: Integer when the rule type is "INTERVAL", "null" otherwise. every_y |
Tracking link parameters
Some additional information needs to be provided in the tracking link. The s1 parameter should include the ID of the user accessing the offer. The ID can be any string up to 255 characters long. The s2,s4 and s5 parameter subids are available. The s3 parameter can not be used.
Updated about 2 months ago