User-Based Offer API

General Concept

The user-based offer API was designed to be called by the client. You can insert a User ID and get all offers for this specific user. The response will be updated based on the user's progress to give the complete flexibility of visualization.

Target Group or Use Case: Use this API to display the (top) offers in your design. You can replace the offer wall integration with this API without changing anything in your backend.


Call the API

Call the Get Offers Endpoint to get an updated list of available offers for the user. These offers are already sorted by performance (score).

Example Response

{
  "data": {
    "offers": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "icon": "string",
        "image": "string",
        "link": "string",
        "is_live": true,
        "target_os": [
          "all"
        ],
        "tasks": [
          {
            "id": 0,
            "description": "string",
            "cpa": "string",
            "value": "string",
            "is_live": true,
            "completed_at": "2022-01-01T12:00:00Z",
            "reconciled_at": "2022-01-01T12:00:00Z"
          }
        ],
        "score": 0,
        "opened_at": "2022-01-01T12:00:00Z",
        "completed_at": "2022-01-01T12:00:00Z",
        "duration": 0,
        "tags": [
          "string"
        ],
        "is_promoted": true,
        "support_url": "string"
      }
    ]
  }
}

📘

We will also return inactive offers (is_live=false) once the user opened the offer. This helps to display a proper history and inform the user about the change.