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.

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": [
      {
        "id": 0,
        "name": "Final Fantasy XV iPhone CPE (US) (Incentive)",
        "anchor": "Final Fantasy XV",
        "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.",
        "translations": {
          "additionalProp": {
            "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": null
            }
          ],
          "operating_systems": [
            {
              "name": "android",
              "min_version": "4.4",
              "max_version": null
            }
          ],
          "devices": [
            {
              "name": "android",
              "min_version": "4.4",
              "max_version": null
            }
          ],
          "platforms": [
            {
              "name": "android",
              "min_version": "4.4",
              "max_version": null
            }
          ]
        },
        "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,
            "multiple_conversions_rules": {
              "rule_type": "unlimited",
              "x_conversions": 1,
              "every_y_seconds": 60
            }
          }
        ],
        "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",
        "country_stats": [
          {
            "country_code": "US",
            "mobile_rank": 1,
            "desktop_rank": 422
          }
        ]
      }
    ]
  }
}

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

Static Offer API

General Concept

Calling the API

Example Response

Categories

Response Parameters