BitLabs API

Get Offers

GET /v2/client/offers

Header api token & Header user Query api token & Query user Header bearer token

Headers

User-Agent string Required

The user agent string of the user's device.

Query parameters

devices array[string]

An array that any combination of iphone, ipad, or android. Provide an empty array to clear existing devices.

Values are iphone, ipad, or android.
in_app boolean | null

If true, only offers that follow App Store and Play Store guidelines are returned. If not set, it falls back to the app setting.
client_user_agent string

The user agent string of the user's device.
client_ip string

The IP address of the user's device.
tags string(URL-encoded query)

Optional set of key-value pairs to be passed back in callbacks. Max 10 pairs with both key and value up to 50 characters long. Keys and values are trimmed and lower-cased. Keys can only contain alphanumeric characters and underscores. Values can contain any characters. If you need to pass sensitive information, note that users can potentially manipulate this data.

Responses

• 200 application/json

OK
Hide response attribute Show response attribute object
- data object
  
  Hide data attributes Show data attributes
  
  offers array[object] Required
  
  Hide offers attributes Show offers attributes object
  
  id integer(int64) Required
  
  anchor string Required
  
  Offer title to display to users
  
  description string Required
  
  Enter to win a Playstation 5!
  
  requirements string Required
  
  What the user should do to complete an offer
  
  confirmation_time string Required
  
  Text that described how long it takes to receive credit
  
  click_url string Required
  
  URL to redirect the user to
  
  support_url string Required
  
  The URL the user can access to get support in case they are not rewarded
  
  icon_url string Required
  
  Square icon URL
  
  categories array[string] Required
  
  total_points string Required
  
  Total points the user may earn
  
  total_points_promotional string
  
  If a promotion is currently in progress, the amount of points they will earn. If not null, this should be used instead of total_points.
  
  is_sticky boolean Required
  
  If an offer should be pinned to the top of the offer wall
  
  events array[object] Required
  
  An array of events the user may complete to earn points. Each event is an object.
  
  Hide events attributes Show events attributes object
  
  uuid string Required
  
  ID of the event
  
  name string Required
  
  Event name to display to the user
  
  type string Required
  
  Flat events have static point values. Dynamic events will have varying payouts.
  
  Values are flat or dynamic.
  
  payable boolean Required
  
  Whether the event pays anything to the user
  
  display_type string Required
  
  This determines how the potential points are displayed. "none": no special logic. User receives {points}. "up_to": display "Up to {points}". "commission": display "{points} per ${commission_amount}
  
  Values are none, up_to, or commission.
  
  points string Required
  
  Will be 0 if the event is not payable.
  
  promotional_points string
  
  Points if there is an ongoing promotion. If not null, this should be used instead of points.
  
  commission_amount string
  
  For "commission", the points amount to use in the phrase above.
  
  app_metadata object Required
  
  Hide app_metadata attributes Show app_metadata attributes
  
  app_id string
  
  The app ID
  
  categories array[string] Required
  
  The categories the app belongs to
  
  screenshot_urls array[string] Required
  
  URLs to screenshots of the app
  
  video_urls array[string] Required
  
  URLs to videos of the app
  
  is_game boolean Required
  
  Indicates if the offer is a game. If true, the offer is a game. If false, the offer is not a game.
  
  stats object Required
  
  Hide stats attributes Show stats attributes
  
  tool_cpm string
  
  The tool CPM for this offer
  
  network_cpm string
  
  The network CPM for this network
  
  started_offers array[object] Required
  
  Hide started_offers attributes Show started_offers attributes object
  
  id integer(int64) Required
  
  anchor string Required
  
  Offer title to display to users
  
  description string Required
  
  Enter to win a Playstation 5!
  
  requirements string Required
  
  What the user should do to complete an offer
  
  confirmation_time string Required
  
  Text that described how long it takes to receive credit
  
  support_url string Required
  
  The URL the user can access to get support in case they are not rewarded
  
  icon_url string Required
  
  Square icon URL
  
  categories array[string] Required
  
  total_points string Required
  
  Total points the user may earn
  
  total_points_promotional string
  
  If a promotion is currently in progress, the amount of points they will earn. If not null, this should be used instead of total_points.
  
  events array[object] Required
  
  An array of events the user may complete to earn points. Each event is an object.
  
  Hide events attributes Show events attributes object
  
  uuid string Required
  
  ID of the event
  
  name string Required
  
  Event name to display to the user
  
  type string Required
  
  Flat events have static point values. Dynamic events will have varying payouts.
  
  Values are flat or dynamic.
  
  payable boolean Required
  
  Whether the event pays anything to the user
  
  display_type string Required
  
  This determines how the potential points are displayed. "none": no special logic. User receives {points}. "up_to": display "Up to {points}". "commission": display "{points} per ${commission_amount}
  
  Values are none, up_to, or commission.
  
  points string Required
  
  Will be 0 if the event is not payable.
  
  promotional_points string
  
  Points if there is an ongoing promotion. If not null, this should be used instead of points.
  
  commission_amount string
  
  For "commission", the points amount to use in the phrase above.
  
  latest_date string(date-time) Required
  
  Date of the latest click or conversions.
  
  points string Required
  
  Will be 0 if the event is not payable.
  
  completed_events integer Required
  
  completed boolean Required
  
  has_pending_conversions boolean Required
  
  offerwall_code string Required

GET /v2/client/offers

curl \
 -X GET https://api.bitlabs.ai/v2/client/offers \
 -H "X-Api-Token: $API_KEY" \
 -H "X-User-Id: $API_KEY" \
 -H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (HTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3"

Response examples (200)

{
  "data": {
    "offers": [
      {
        "id": 42,
        "anchor": "Playstation 5",
        "description": "Playstation 5",
        "requirements": "Sign up with valid information and complete the full survey.",
        "confirmation_time": "Confirms Instantly",
        "click_url": "string",
        "support_url": "https://wall.adgaterewards.com/offer/contact/nQ/100677?s1=",
        "icon_url": "https://main-p.agmcdn.com/offers/1639000851514.jpg",
        "categories": [
          "Free",
          "Android"
        ],
        "total_points": "string",
        "total_points_promotional": "string",
        "is_sticky": true,
        "events": [
          {
            "uuid": "0dc43f54-135a-46a4-a51c-a2c5f3cfdac0",
            "name": "Completed",
            "type": "flat",
            "payable": true,
            "display_type": "none",
            "points": "string",
            "promotional_points": "string",
            "commission_amount": "string"
          }
        ],
        "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,
        "stats": {
          "tool_cpm": "string",
          "network_cpm": "string"
        }
      }
    ],
    "started_offers": [
      {
        "id": 42,
        "anchor": "Playstation 5",
        "description": "Playstation 5",
        "requirements": "Sign up with valid information and complete the full survey.",
        "confirmation_time": "Confirms Instantly",
        "support_url": "https://wall.adgaterewards.com/offer/contact/nQ/100677?s1=",
        "icon_url": "https://main-p.agmcdn.com/offers/1639000851514.jpg",
        "categories": [
          "Free",
          "Android"
        ],
        "total_points": "string",
        "total_points_promotional": "string",
        "events": [
          {
            "uuid": "0dc43f54-135a-46a4-a51c-a2c5f3cfdac0",
            "name": "Completed",
            "type": "flat",
            "payable": true,
            "display_type": "none",
            "points": "string",
            "promotional_points": "string",
            "commission_amount": "string"
          }
        ],
        "latest_date": "2022-01-01T00:00:00Z",
        "points": "string",
        "completed_events": 42,
        "completed": true,
        "has_pending_conversions": true
      }
    ],
    "offerwall_code": "string"
  }
}