Client API

The following api is for client side only, meaning you can directly integrate our offers on your client side using javascript or similar code/framework

Get Offers

Get Offers

GET https://api.adbreakmedia.com/api/offers

Get All active Offers directly for clientside

Query Parameters

Name	Type	Description
identifier*	String	Your Placement Identifier
userId*		The id of the user
sub1		Extra value (it will be returned back to you)
sub2		Second Extra value (it will be returned back to you)

200 Offers fetched Successfully

Offers

field	Description	Example
id	ID of the Offer	5026
name	Offer Name to display to the user	Lords Mobile
description	Offer Description to display to the user	Discover the kingdom
payout	The total payout that will be awarded for completing this Offer (your currency)	9080
events.id	id of the event	646fe4c6753722fa9f6c621b
events.action	predefined requirements for users to trigger conversion	Defeat Level 2 Monster
epc	earning per click value of an offer	0.2
verification	if user is suspicious or the offer is more sensitive on frauds, this is required, none , id , phone , both	none
multipleTimes	boolean value, it means if the offer can be completed multiple times or not! true, false	false
isFeatured	boolean value, to feature offer on top : true, false	true
icon	Offer icon image to display to the user	https://play-lh.googleusercontent.com/oFz-KTIgL6yAuuA5XeHapTQLDcoBVgA9JXCTiID70rPcJBGAT9DdiqNDjNLxcYaG6W3W=s120-rw
category	category of the offer, app, web etc	app
url	tracking url of the offer	https://api.adbreakmedia.com/api/offers/click?offerId=5026&userId=1234&placementId=1
device	Array of supported device android, ios, desktop	android
popularity	score of the offer depending on it's performance from 0-100	80

Other Params

field	Description	Example
error	boolean value : true, false	false
message	message to determine offer fetching errors	Offers fetched successfully
device	User's Device based on our detection	desktop
userId	The user id you passed to us	1234

{
  "error": false,
  "message": "Offers fetched successfully",
  "device": "desktop",
  "userId": "1234",
  "user": "c49af49767d9a0eb5c26e2c0d6aea5a58b20a87d",
  "userStatus": "active",
  "userVerification": "none",
  "placementId": 1,
  "placementStatus": "active",
  "currency": "Coins",
  "eventStatus": "inactive",
  "eventMultiplier": 1,
  "eventMessage": "",
  "offers": [
    {
      "id": 5026,
      "name": "Lords Mobile",
      "description": {
        "en": "The true Emperor has fallen. We need a real hero, a true Lord who can unite the Kingdoms. Recruit heroes from various backgrounds, from dwarves and mermaids to dark elves and steampunk robots, and assemble your army in this magical world! Fight and conquer to establish your empire in one of the strategy games!"
      },
      "payout": 9080,
      "events": [
        {
          "id": "646fe4c6753722fa9f6c621b",
          "action": {
            "en": "install , open & defeat level 2 Monster"
          },
          "payout": 9080
        }
      ],
      "epc": 0.2
      "verification": "none",
      "multipleTimes": false,
      "isFeatured": false,
      "icon": "https://play-lh.googleusercontent.com/oFz-KTIgL6yAuuA5XeHapTQLDcoBVgA9JXCTiID70rPcJBGAT9DdiqNDjNLxcYaG6W3W=s120-rw",
      "category": ["app"],
      "url": "https://api.adbreakmedia.com/api/offers/click?offerId=5026&userId=1234&placementId=1",
      "device": ["android"],
      "popularity": "80"
    }
  ]
}

400: Bad Request Missing Parameters

{
  "error": true,
  "message": "Missing parameters"
}

404: Not Found Placement Not Active

{
  "error": true,
  "message": "Placement not found or inactive"
}

Get userHistory

Get User History

GET https://api.adbreakmedia.com/api/users/userHistory

Get All user history directly for client side

Query Parameters

Name	Type	Description
placement_identifier*	String	Your Placement Identifier
userId*	String	The id of the user

200: OK History Fetched Successfully

Note: payoutEarned param is only available on multievent offers

{
    "success": true,
    "history": [
        {
            "id": "c09a559ee2c3d5d9dfb8793b7af822bb4968279a",
            "offer": {
                "id": 4490,
                "name": "Earn Cash ",
                "description": {
                    "en": "Users can earn money by playing games, downloading apps or completing surveys in a modern and exciting experience."
                },
                "multiEvent": false,
                "icon": "https://main-p.agmcdn.com/tyZRqlscOW5jj3tZN8S856UzkquZXMO3Y7TMhZoE.png",
                "category": "web"
            },
            "totalPayout": 21.84,
            "isRequested": false,
            "status": "clicked",
            "createdAt": "2023-06-26T05:41:48.883Z"
        },
        {
            "id": "cf730dc9e29db3c1cf21f0d72b386b5958e4822f",
            "offer": {
                "id": 4990,
                "name": "Idle Bank",
                "description": {
                    "en": "Run your own Idle Bank games, Print money games, serve clients, give out loans and get Rich in the newest Idle Business Tycoon Games."
                },
                "multiEvent": true,
                "icon": "https://main-p.agmcdn.com/Gcx3dhMcPSqrMQ9DZbYK9MImz8aWOsuipzns4Ewy.webp",
                "category": "app"
            },
            "totalPayout": 13.747,
            "payoutEarned": 0,
            "isRequested": false,
            "status": "clicked",
            "createdAt": "2023-08-01T12:20:03.210Z"
        },
        {
            "id": "5b3723dd474e609c320a96627b7567f0e4b276bd",
            "offer": {
                "id": 66429,
                "name": "Honeygain: Make Money Online",
                "description": {
                    "en": "Start earning money by sharing your internet connection with data analysts. Honeygain allows you to reach unused internet's full potential in the most convenient way!"
                },
                "multiEvent": false,
                "icon": "https://is2-ssl.mzstatic.com/image/thumb/Purple122/v4/4f/d0/7e/4fd07e37-beff-4bd4-cbf5-cda6dba52b4f/AppIcon-0-1x_U007emarketing-0-7-0-85-220.png/512x512bb.jpg",
                "category": "web"
            },
            "totalPayout": 0.48,
            "isRequested": false,
            "status": "clicked",
            "createdAt": "2023-08-01T12:17:15.885Z"
        }
    ]
}

Good to know: If you have any queries or feel difficulty in integrating our offers, reach out to our publisher support at [e-mail] and they will help you solve your issue.