Offers API

GET https://api.offer18.com/api/af/offers

🔗 Click to Test Offers API

Common Parameters

Parameter

Type

Description

key

String

API Key

aid

Integer

Affiliate Id

mid

Integer

Your Advertiser MID


Filters

Query

Type

Description

offer_id

Integer

OfferID (&offer_id=000,001,002)

page

Integer

Page Number (&page=1)

category

String

Offer's category (&category=000,000,000)

model

String

Offer Model (&model=CPA,CPC)

country

String

Country Based Offers (&country=US, IN, AU)

offer_status

Integer

Allowed values: 1: Active offers (&offer_status=1)

authorized

Integer

Allowed values: 1: Assigned Offers (&authorized=1)

https://api.offer18.com/api/af/offers?key=000000000&aid=0000&mid=0000&offer_id=0000000&model=000


Example API Request


API Response

{
  "response": "200",
  "data": {
    "00011": {
      "offerid": "00011",
      "name": "XXXXX",
      "logo": "https://example.com/sample.jpeg/",
      "status": "active",
      "category": "download campaigns, gaming, subscription offers, Ecommerece Campaign",
      "currency": "USD",
      "price": 100,
      "model": "CPA",
      "date_start": "2019-05-09 02:19:00",
      "date_end": "2021-08-31 02:19:00",
      "preview_url": "https://www.example.com/?offerid=00011",
      "offer_terms": "These are the offer terms",
      "offer_kpi": "",
      "country_allow": "IN,US",
      "country_block": "GB",
      "city_allow": "",
      "city_block": "",
      "os_allow": "",
      "os_block": "",
      "device_allow": "",
      "device_block": "",
      "isp_allow": "",
      "isp_block": "",
      "browser_allow": "",
      "browser_block": "",
      "capping": [
        {
          "rule_type": "shared_capping",
          "event": "",
          "type": "gross_conversions",
          "period": "daily",
          "value": 100,
          "timezone": null,
          "rule_id": "00000"
        },
        {
          "rule_type": "affiliate_capping",
          "event": "",
          "type": "approved_conversions",
          "period": "daily",
          "value": 100,
          "timezone": null,
          "rule_id": "00000"
        }
      ],
      "events": [
        {
          "event_name": "reagistration",
          "event_token": "reagistration"
        }
      ],
      "payout": [
        {
          "payout": "515.0000",
          "currency": "USD",
          "model": "CPA",
          "condition": [
            [
              {
                "field": "event",
                "operator_type": "is_equal",
                "value": "reagistration"
              },
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "US"
              },
              {
                "field": "device_type",
                "operator_type": "is_equal",
                "value": "smartphone"
              },
              {
                "field": "browser",
                "operator_type": "is_equal",
                "value": "ch"
              },
              {
                "field": "os",
                "operator_type": "is_equal",
                "value": "android"
              }
            ]
          ],
          "rule_id": "00000"
        }
      ],
      "impression_url": "https://mynet.o18.click/i?o=00011&m=000&a=00000",
      "click_url": "https://mynet.o18.click/c?o=00011&m=000&a=00000",
      "authorized": "true",
      "creatives": [
        {
          "type": "image",
          "url": "https://example.com/creative_00001.png"
        },
        {
          "type": "image",
          "url": "https://example.com/creative_00002.png"
        },
        {
          "type": "html",
          "url": "https:example.com/creative00002.zip"
        }
      ],
      "targeting": [
        {
          "action_on_clicks": "allow",
          "condition": [
            [
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "IN,US"
              },
              {
                "field": "device_type",
                "operator_type": "not_equal",
                "value": "smartphone"
              }
            ]
          ],
          "rule_id": "101"
        },
        {
          "action_on_clicks": "reject",
          "condition": [
            [
              {
                "field": "os",
                "operator_type": "not_equal",
                "value": "android"
              }
            ]
          ],
          "rule_id": "102"
        },
        {
          "action_on_impressions": "allow",
          "condition": [
            [
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "IN,US"
              },
              {
                "field": "os",
                "operator_type": "is_equal",
                "value": "windows"
              }
            ]
          ],
          "rule_id": "103"
        }
      ]
    }
  }
}

Shared Capping - A single capping rule shared by multiple Affiliates.

Apply Offer

Query

Type

Description

offer_access

Integer

Allowed values 1: Approve Public Offers (&offer_access=1)

https://api.offer18.com/api/af/offers?key=000000000&aid=0000&mid=0000&offer_access=1

Last updated