Sign in

v1

latestOpenAPI 3.0.02026-07-2663155142.2 KB
Server-Side

Get Offers for Publishers

Returns a list of offers that are available for all users. Note that this is not customized for any user.

get/v2/publishers/offers

Query parameters

limitinteger

Limit the number of results to X.

skipinteger

Skips the first X number of results.

countriesstring[]

Filter by specific countries using ISO country codes.

[
  "gb",
  "us",
  "ca"
]
offer_idsstring

Filter by specific offers. Accepts a list of comma separated offer IDs.

Example:4849,5201,4809
pay_minstring

Filter by offers above a minimum payout. Values are in USD.

Example:0.50
min_epcstring

Filter by offers above a minimum EPC. Values are in USD.

Example:0.05
categoriesstring

Filter by offers in certain categories. Accepts a comma separated list of category IDs.

Example:4,10,11
platformsstring

Filter by specific platforms. Accepts a list of comma separated platforms from desktop, smartphone, tablet.

Example:smartphone,tablet
order_by'payout' | 'epc' | 'id'

Order results by either payout, epc, or id(offer id) in descending order. payout is calculated as the maximum payout from the offer's events. Default is epc.

Example:payout

Response

OK

Example response

{
  "data": {
    "offers": [
      {
        "name": "Final Fantasy XV iPhone CPE (US) (Incentive)",
        "anchor": "Final Fantasy XV",
        "country_stats": [
          {
            "country_code": "US",
            "mobile_rank": 1,
            "desktop_rank": 422
          }
        ],
        "description": "Be the hero of your own Final Fantasy XV adventure in the brand new mobile strategy game Final Fantasy XV!",
        "requirements": "Install and Reach Citadel level 10.",
        "things_to_know": [
          "Must be a UK resident.",
          "Award will pend for 30 days."
        ],
        "disclaimer": "Must be a UK resident. ${currencyname} will appear as Pending for 30 days. This offer is presented to you by ${sitename} on behalf of a third party merchant. ${sitename} has not evaluated and does not endorse Merchant's views, policies, products or services.",
        "pending_time": 12,
        "device_targeting": {
          "browsers": [
            {
              "name": "android",
              "min_version": "4.4"
            }
          ],
          "operating_systems": [
            {
              "name": "android",
              "min_version": "4.4"
            }
          ],
          "devices": [
            {
              "name": "android",
              "min_version": "4.4"
            }
          ],
          "platforms": [
            {
              "name": "android",
              "min_version": "4.4"
            }
          ]
        },
        "geo_targeting": {
          "countries": [
            {
              "country_code": "US",
              "geoname_id": 5883102,
              "name": "Alberta",
              "code": "T1X 0L3"
            }
          ],
          "states": [
            {
              "country_code": "US",
              "geoname_id": 5883102,
              "name": "Alberta",
              "code": "T1X 0L3"
            }
          ],
          "cities": [
            {
              "country_code": "US",
              "geoname_id": 5883102,
              "name": "Alberta",
              "code": "T1X 0L3"
            }
          ],
          "postal_codes": [
            {
              "country_code": "US",
              "geoname_id": 5883102,
              "name": "Alberta",
              "code": "T1X 0L3"
            }
          ]
        },
        "icon": "https://main-p.agmcdn.com/offers/1564507470875.gif",
        "creatives": {
          "icon": "https://main-p.agmcdn.com/offers/1564507470875.gif",
          "images": {
            "120x60": "https://main-p.agmcdn.com/cdn-cgi/image/width=120,height=60/https://main-p.agmcdn.com/offers/26500-CON9Efq8.jpg",
            "275x275": "https://main-p.agmcdn.com/cdn-cgi/image/width=275,height=275/https://main-p.agmcdn.com/offers/26500-GwW1MNhL.jpg",
            "400x400": "https://main-p.agmcdn.com/cdn-cgi/image/width=400,height=400/https://main-p.agmcdn.com/offers/26500-GwW1MNhL.jpg"
          }
        },
        "categories": [
          "iPhone"
        ],
        "events": [
          {
            "id": "a9bf882a-5e06-49de-8cf7-a708ac653636",
            "hash": "a1b2c3d4e5f6g7h8",
            "name": "install app",
            "payout": "1.30",
            "points": "130.12",
            "promotional_points": "150.29",
            "multiple_conversions_rules": {
              "x_conversions": 1,
              "every_y_seconds": 60
            }
          }
        ],
        "click_url": "https://bitlabs.link/vc/nQ/offers/100677?s1=",
        "support_url": "https://wall.adgaterewards.com/offer/contact/nQ/100677?s1=",
        "preview_url": "https://itunes.apple.com/app/final-fantasy-xv-a-new-empire/id1186994231?mt=8",
        "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=..."
          ]
        },
        "advertiser_id": 234567890,
        "total_points": 1000,
        "total_promotional_points": 100,
        "session_hours": 24,
        "lowest_cap_left": 150,
        "arpu_goals": [
          {
            "day": 1,
            "goal": "2.40"
          },
          {
            "day": 7,
            "goal": "8.49"
          }
        ]
      }
    ]
  }
}