BitLabs API

Get Offers for Publishers

GET /v2/publishers/offers

Query parameters

limit integer

Limit the number of results to X.

Default value is 200.
skip integer

Skips the first X number of results.

Default value is 0.

Responses

• 200 application/json

OK
Hide response attribute Show response attribute object
- data object
  
  Hide data attribute Show data attribute
  
  offers array[object] Required
  
  Hide offers attributes Show offers attributes object
  
  id integer(int64) Required
  
  name string Required
  
  Internal offer name, not to be displayed to end-users.
  
  anchor string Required
  
  Offer title as shown to the end-user.
  
  description string Required
  
  Offer description.
  
  requirements string Required
  
  Offer requirements. The user must complete these requirements in order to convert.
  
  translations object Required
  
  Available translations for the offer anchor, description and requirements.
  
  Hide translations attributes Show translations attributes
  
  Additional properties
  
  anchor string
  
  description string
  
  requirements string
  
  device_targeting object Required
  
  Hide device_targeting attributes Show device_targeting attributes
  
  browsers array[object] Required
  
  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)
  
  Hide browsers attributes Show browsers attributes object
  
  name string Required
  
  min_version string
  
  Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null.
  
  max_version string
  
  Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null.
  
  operating_systems array[object] Required
  
  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)
  
  Hide operating_systems attributes Show operating_systems attributes object
  
  name string Required
  
  min_version string
  
  Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null.
  
  max_version string
  
  Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null.
  
  devices array[object] Required
  
  If present, the offer requires one of the specified devices. Possible values are: iphone, ipad (More values may be added in the future)
  
  Hide devices attributes Show devices attributes object
  
  name string Required
  
  min_version string
  
  Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null.
  
  max_version string
  
  Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null.
  
  platforms array[object] Required
  
  If present, the offer requires one of the specified platforms. Possible values are: smartphone, tablet, desktop (More values may be added in the future)
  
  Hide platforms attributes Show platforms attributes object
  
  name string Required
  
  min_version string
  
  Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null.
  
  max_version string
  
  Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null.
  
  geo_targeting object Required
  
  Hide geo_targeting attributes Show geo_targeting attributes
  
  countries array[object] Required
  
  uses country_code
  
  Hide countries attributes Show countries attributes object
  
  country_code string
  
  The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK.
  
  geoname_id integer(int64)
  
  The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/
  
  name string
  
  The name of the state/region/city as provided by Geonames.
  
  code string
  
  The postal code the offer is limited to.
  
  states array[object] Required
  
  uses geoname_id & name
  
  Hide states attributes Show states attributes object
  
  country_code string
  
  The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK.
  
  geoname_id integer(int64)
  
  The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/
  
  name string
  
  The name of the state/region/city as provided by Geonames.
  
  code string
  
  The postal code the offer is limited to.
  
  cities array[object] Required
  
  uses geoname_id & name
  
  Hide cities attributes Show cities attributes object
  
  country_code string
  
  The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK.
  
  geoname_id integer(int64)
  
  The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/
  
  name string
  
  The name of the state/region/city as provided by Geonames.
  
  code string
  
  The postal code the offer is limited to.
  
  postal_codes array[object] Required
  
  uses code
  
  Hide postal_codes attributes Show postal_codes attributes object
  
  country_code string
  
  The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK.
  
  geoname_id integer(int64)
  
  The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/
  
  name string
  
  The name of the state/region/city as provided by Geonames.
  
  code string
  
  The postal code the offer is limited to.
  
  icon string Required
  
  epc string Required
  
  Network-wide EPCs
  
  categories array[string] Required
  
  An array of offer categories
  
  events array[object] Required
  
  An array of offer events.
  
  Hide events attributes Show events attributes object
  
  id string Required
  
  UUID of the event
  
  name string Required
  
  Event title
  
  payout_type string Required
  
  One of "flat" or "dynamic". Flat payouts don't change. Dynamic payouts vary. Only 'flat' events are served at the moment.
  
  Values are flat or dynamic.
  
  payout string Required
  
  The dollar amount.
  
  is_cpc boolean Required
  
  Boolean. Indicates if the offer event is CPC (cost-per-click).
  
  multiple_conversions_allowed boolean Required
  
  Boolean. Indicates if the offer event allows multiple conversions for a single user (IP), according to the rules specified in "multiple_conversions_rules".
  
  multiple_conversions_rules object
  
  Hide multiple_conversions_rules attributes Show multiple_conversions_rules attributes
  
  rule_type string Required
  
  Values are unlimited or interval.
  
  x_conversions integer Required
  
  every_y_seconds integer Required
  
  click_url string Required
  
  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. s2,s3,s4 and s5 subids are available.
  
  support_url string Required
  
  The URL the user can access to get support in case they are not rewarded. The s1 parameter is required (see click_url above for info.) Note that most offers require waiting at least one hour after clicking an offer to be able to contact support.
  
  preview_url string Required
  
  Preview of the offer's landing page.
  
  country_stats array[object] Required
  
  Only present if "multiple_conversions_allowed" is true. It is an object with the following values:
  
  rule_type: "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_seconds: Integer when the rule type is "INTERVAL", "null" otherwise.
  
  More attempts than the rule allows will not result in a conversion.
  
  Hide country_stats attributes Show country_stats attributes object
  
  country_code string Required
  
  mobile_rank integer Required
  
  desktop_rank integer Required

GET /v2/publishers/offers

curl \
 -X GET https://api.bitlabs.ai/v2/publishers/offers \
 -H "X-S2S-Token: $API_KEY"

Response examples (200)

{
  "data": {
    "offers": [
      {
        "id": 42,
        "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": {
          "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,
            "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
          }
        ]
      }
    ]
  }
}