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
, orandroid
. -
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.
GET
/v2/client/offers
curl \
--request GET 'https://api.bitlabs.ai/v2/client/offers' \
--header "X-Api-Token: $API_KEY" \
--header "X-User-Id: $API_KEY" \
--header "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",
"impression_url": "https://seek:gg/v1/user-based-api/impression?funnel_id=01JKBMPR5QYT91EGGV1R62DB2W&wall_code=nqqYp2g&user_id=testuser&offer_id=1666524",
"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",
"payout": "1.30",
"status": "viewed",
"type_id": 42,
"ttc_minutes": 42,
"expires_at": 42,
"time_played": {
"id": 42,
"goal_unit": "string",
"goal_unit_count": 42
},
"multiple_conversions_allowed": true,
"multiple_conversions_rules": {
"rule_type": "string",
"x_conversions": 42,
"every_y_seconds": 42
}
}
],
"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"
},
"disclaimer": "string",
"pending_time": 60,
"web_to_mobile": true,
"web_to_mobile_devices": [
"iphone",
"ipad"
],
"epc": "string",
"session_hours": 24,
"offer_expires_at": "2021-12-31T23:59:59Z",
"product_id": "string",
"product_name": "string",
"things_to_know": [
"string"
],
"creatives": {
"images": {
"additionalProperty1": "string",
"additionalProperty2": "string"
}
},
"mobile_verification_required": true,
"funnel_id": "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",
"payout": "1.30",
"status": "viewed",
"type_id": 42,
"ttc_minutes": 42,
"expires_at": 42,
"time_played": {
"id": 42,
"goal_unit": "string",
"goal_unit_count": 42
},
"multiple_conversions_allowed": true,
"multiple_conversions_rules": {
"rule_type": "string",
"x_conversions": 42,
"every_y_seconds": 42
}
}
],
"latest_date": "2022-01-01T00:00:00Z",
"points": "string",
"completed_events": 42,
"completed": true,
"has_pending_conversions": true,
"disclaimer": "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=..."
]
},
"hours_left": 24
}
],
"offerwall_code": "string"
}
}