API documentation  GET /offers

Get the list of offers with optional filters.

GET https://demo.trafficmanager.com/api/v1/offers

Authentication:

The request must be authenticated with the following HTTP headers:

• x-api-key: Your API key, found in the Security page
• x-user-id: Your User ID, found in the Security page

GET Parameters:

• Optional:
• mainCategory: offer's main category ID
• countries: countries selected for the offer (country codes)
• accessGranted: if set, only the offers where the affiliate has access to will be returned (in other words, the offers with "apply needed" will be excluded unless the user has applied and the application has been accepted)
• ids: comma-separated list of offer IDs

Returned values:

• id: offer ID
• name: offer name
• description: offer full HTML description as it appears in the Marketplace
• image: offer image
• category: the main category of the offer
• countries: Array of country codes for which the offer accepts traffic
• visibility: offer visibility (1: public, 2: apply needed, 3: private)
• is_featured: whether the offer is featured or not
• tags: offer tags
• payout_mode: offer payout mode
• payout: offer payout (numeric)
• payout_full: offer payout in human-readable format, as displayed in the Marketplace
• url: offer tracking links
• • all: for all the landing pages
  • lp: for each lp (in case the offer has more than one)
  • lpNames: lp names
• optional devices: array of devices for which the offer accepts traffic. The field if missing if the offer accepts traffic from all devices.
• optional product_price: price of the product. Available only for offers with products.
• optional counties: if the offer accept only traffic from specific country subdivisions, the list of subdivisions will be returned.
• optional cities: if the offer accept only traffic from specific cities, the list of cities will be returned.
• optional connection_types: possible options are Cellular and Wifi.
• optional events: list of events. Only for offers with events.
• optional revenue_share_tiers: list of revenue share tiers. Only for offers with this payout mode.

Request example

GET https://demo.trafficmanager.com/api/v1/offers?countries[1]=AD&countries[2]=RO&mainCategory=1&accessGranted=1

Response example

{
    "offers": [
        {
            "id": 9,
            "name": "New offer",
            "description": "Description1",
            "image": "https://static.trafficmanager.com/offers/screenshots/5f7f0308c89da.jpeg",
            "category": "Adult",
            "countries": [
                "US"
            ],
            "visibility": 1,
            "is_featured": 0,
            "tags": "",
            "payout_mode": "CPA",
            "payout": 12,
            "url": {
                "all": "https://offers.trafficman.io/?offer=9&uid=6672616e-6365-7363-6f2d-6c6f6b6b6100",
                "lp": {
                    "9": "https://offers.trafficman.io/?offer=9&uid=6672616e-6365-7363-6f2d-6c6f6b6b6100&lp=9"
                },
                "lpNames": {
                    "9": "Default"
                }
            }
        },
        {
            "id": 8,
            "name": "Offer XYZ",
            "description": "Full description of the offer",
            "image": "",
            "category": "Adult",
            "countries": [
                "RO"
            ],
            "visibility": 2,
            "is_featured": 0,
            "tags": "",
            "payout_mode": "CPA",
            "payout": 0,
            "url": {
                "all": "https://offers.trafficman.io/?offer=8&uid=6672616e-6365-7363-6f2d-6c6f6b6b6100",
                "lp": {
                    "8": "https://offers.trafficman.io/?offer=8&uid=6672616e-6365-7363-6f2d-6c6f6b6b6100&lp=8"
                },
                "lpNames": {
                    "8": "Default"
                }
            }
        }
    ],
    "status": 200
}