Get offers

HTTP method Endpoint
GET /aff/v1/batches/offers

Path parameters

Parameter Description
all All offers.
personal Personal offers.

Query string parameters

Conditions Parameters Type Description
type type type Possible Values:
all · personal
Offset offset offset Check page scale.
Limit limit limit The number of date displays in each page. (Maximum = 100)
Sort sort sort Ranking according to the specified field ascending "+", or descending "-". Only id sorting is supported.
Fields fields field You can choose the field of the query (the result of the query is in line with the selected field).
id integer A string that uniquely identifies this offer.
name string The name of the this Offer
end_date integer The expiration date of the Offer.
status string The current status of the offer.
pricing_type string The current pricing_type of the offer.
Possible Values:
CPA · CPI · CPC · CPS · CPA+CPS
payout string The payout of the offer.
preview_url string URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
thumbnail string The offer’s thumbnail of the link address.
category string The category of the offer (categroy means the tag information).
offer_approval integer Whether this Offer requires manual approval before an Affiliate can run it.
tracking_link string Tracking link.
currency string The currency of the Offer.
conversion_protocol integer The Conversion tracking method to use for the Offer.
offer_event object Offer events defined for the offer.
offer_vbt object Volume based tiers defined for the offer.
offer_geo object Geo targeted by the offer.
offer_platform object Platforms targeted by the offer.
offer_cap object Offer caps defined for the offer.
offer_postback object Offer postbacks associated with the offer.
offer_creative object Offer creatives associated with the offer.
app_id string the App ID on app store or google play.
Filters filters filter Query requirements of Specify field.
EQUAL_TO
NOT_EQUAL_TO
LESS_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
id integer A string that uniquely identifies this offer.
name string The name of the this Offer
pricing_type string The current pricing_type of the offer.
Possible Values:
CPA · CPI · CPC · CPS · CPA+CPS
offer_approval integer Whether this Offer requires manual approval before an Affiliate can run it.
currency string The currency of the Offer.
conversion_protocol integer The Conversion tracking method to use for the Offer.
geo_country string Only support the following ways, EQUAL_TO
For example,filters[geo_country][EQUAL_TO]=CN
offer_platform string Only support the following ways, EQUAL_TO
For example,filters[offer_platform][EQUAL_TO]=PC
category string Only support the following ways, EQUAL_TO.
For example,filters[category][EQUAL_TO]=test
app_id string the App ID on app store or google play,EQUAL_TO.
For example,filters[app_id][EQUAL_TO]=offerslook.com
Contains contains string List of related objects to return with each result.
description string A description for the Offer. Default does not return, if needed, by the following ways. For example,contains=description
EPC1 string Offers can be pulled according to EPC, for example,contains=EPC1,EPC1 means offers is pulled according to EPC of today
EPC2 string EPC2 means offers is pulled according to EPC of yesterday
EPC3 string EPC3 means offers is pulled according to EPC of last three days
EPC4 string EPC4 means offers is pulled according to EPC of last 7 days
CR1 string Offers can be pulled according to CR, for example,contains=CR1,CR1 means offers is pulled according to CR of today
CR2 string CR2 means offers is pulled according to CR of yesterday
CR3 string CR3 means offers is pulled according to CR of last three days
CR4 string CR4 means offers is pulled according to CR of last 7 days

Response body parameters

Field Type Description
offer
id integer A string that uniquely identifies this offer.
name string The name of the this offer
end_date integer The expiration date of the offer.
status string The current status of the offer.
category string The category of the this offer.
pricing_type string The current pricing_type of the offer.
Possible Values:
CPA · CPI · CPC · CPS · CPA+CPS
payout string The payout of the offer.
percent_payout string Percent payout.
preview_url string URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
description string A description for the Offer.
thumbnail string The offer’s thumbnail of the link address.
offer_approval integer Whether this Offer requires manual approval before an Affiliate can run it.
tracking_link string Tracking link.
currency string The currency of the Offer.
carrier array Mobile Carrier
app_id string the App ID on app store or google play
cap_exceed_status boolean When request type=personal, cap_exceed_status field will be returned;
true means cap reaches, false means cap unreached.
impression_pixel string impression pixel.
browser array Browser
offer_url
type string the type of preview url for opposite tracking link:
1). default: the default preview url of this offer.
2).random: the random preview url of this offer.
3).offer url: other types of preview urls.
name string The name of the this multiple
tracking_link string The tracking link url of the landing page
preview_url string URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
conversion_protocol integer The Conversion tracking method to use for the Offer.
offer_event Volume based payout tiers of this offer.
event_id integer Event id.
event_name string Event name.
event_payout_type string Possible Values:
CPC · CPI · CPA · CPS · CPA+CPS
event_payout string Event payout.
event_percent_payout string Event percent payout.
conversion_protocol integer The Conversion tracking method to use for the event.
Possible Values:
1:Image Pixel;
2:Postback URL;
3:iFrame Pixel
offer_vbt
offer_id integer Offer id.
time_interval_type integer Time interval type.
effective_time integer Effective time.
expiration_time integer Expiration time.
tier_item
volume_caps integer Volume Based Tiers Volume Caps.
payout string Volume Based Tiers Payout.
percent_payout string Percent payout.
sort integer Volume Based Tiers Sort.
range string Volume Based Tiers Range.
offer_geo
id integer
offer_id integer A string that uniquely identifies this offer.
country string Country to be targeted.
country_code string Country code.
city array City in targeted country.
type integer An identifier included or excluded.
offer_platform
id integer
offer_id integer A string that uniquely identifies this offer.
platform string Devices to be targeted, it might be PC/Mobile/Tablet.
system string Operating System in Device. By default it allows all OS in targeted platform.
version array Version of the system. By default it allows all versions in targeted system.
is_above integer A new field, is_above, is added to offer platform to support upper compatibility in platform. When new platform versions are upgraded, the traffic won’t be rejected.
Allowed values:
0 Close;
1 Open
offer_cap
id integer
offer_id integer A string that uniquely identifies this offer.
cap_budget string
cap_click integer
cap_type integer Cap type:
cap_conversion integer
category integer Category type:
cap_timezone string Time zone.
offer_postback
id integer Affiliate payout id.
offer_id integer Offer id.
affiliate_id integer Affiliaite id
event_id integer Event id.
code string Code.
status string Status of Postback. Pending; Approved; rejected
type string Type of code.
create_time integer Create time.
update_time integer Update time.
offer_creative
id integer The unique id for the creative.
offer_id integer A string that uniquely identifies this offer.
url string Creative file download link.
mime string Types of creative documents.
size integer The size of the creative file.
width integer Width of creative file (image type).
height integer Height of creative file (image type).
totalPages integer The list of data pages (associated with your limit).
totalRows integer Total number of available data.
offset integer The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.
limit integer The number of data displayed on one page

Example request

Request GET https://{networkname}.api.offerslook.com/aff/v1/batches/offers?type=personal&sort=-id&offset=2&limit=2&contains=description&filters[pricing_type][EQUAL_TO]=CPC&filters[geo_country][EQUAL_TO]=CN


Request GET http://{networkname}.api.offerslook.com/aff/v1/batches/offers?type=personal&sort=-id&offset=2&limit=2&contains=description&filters[pricing_type][EQUAL_TO]=CPC&filters[geo_country][EQUAL_TO]=CN


Example response


    {
      "code": 0,
      "message": "Success",
      "data": {
        "rowset": [
          {
            "offer": {
              "id": 290,
              "name": "offerslook",
              "category": "",
              "offer_approval": 1,
              "tracking_link": "No permissions visit this resource",
              "end_date": 1570118399,
              "pricing_type": "CPC",
              "payout": "53",
              "preview_url": "http://www.offerslook.com",
              "impression_pixel": "No permissions visit this resource",
            },
            "offer_event": [
              {
                "event_id": 1,
                "event_name": "Initial Event",
                "event_payout_type": "CPC",
                "event_payout": "53",
                "event_percent_payout": "-1",
                "conversion_protocol": 2
              }
            ],
            "offer_vbt": "",
            "offer_geo": {
              "type": 1,
              "target": [
                {
                  "type": 1,
                  "country": "Albania",
                  "country_code": "AL",
                  "city": [

                  ],
                  "id": 2669,
                  "offer_id": 290
                },
                {
                  "type": 1,
                  "country": "Armenia",
                  "country_code": "AM",
                  "city": [
                    "Kapan",
                    "Agarak",
                    "Azatamut"
                  ],
                  "id": 2670,
                  "offer_id": 290
                },
                {
                  "type": 2,
                  "country": "China",
                  "country_code": "CN",
                  "city": [
                    "Guanzhuang",
                    "Liudong"
                  ],
                  "id": 2671,
                  "offer_id": 290
                }
              ]
            },
            "offer_platform": {
              "target": [
                {
                  "id": 1917,
                  "offer_id": 290,
                  "platform": "PC",
                  "system": "",
                  "version": [

                  ],
                  "is_above": 1
                },
                {
                  "id": 1918,
                  "offer_id": 290,
                  "platform": "Mobile",
                  "system": "Android",
                  "version": [

                  ],
                  "is_above": 0
                },
                {
                  "id": 1919,
                  "offer_id": 290,
                  "platform": "Mobile",
                  "system": "iOS",
                  "version": [
                    "5.1",
                    "6.0",
                    "6.1"
                  ],
                  "is_above": 1
                }
              ]
            },
            "offer_cap": {
              "id": 290,
              "offer_id": 290,
              "cap_type": 1,
              "cap_click": 2,
              "cap_conversion": 0,
              "cap_budget": "0",
              "category": null,
              "cap_timezone": "Australia/Lord_Howe"
            }
          },
          {
            "offer": {
              "id": 91,
              "name": "test",
              "category": "",
              "offer_approval": 1,
              "tracking_link": "http://www.offerslook.com?offer_id=91&aff_id=161",
              "end_date": 1497715199,
              "pricing_type": "CPC",
              "payout": "2",
              "preview_url": "http://www.baidu.com",
              "impression_pixel": "<img src='http://qoqololo.iuniontrack.com:9080/impr.php?offer_id=91&aff_id=161'  border='0'  width='1'  height='1' />",
            },
            "offer_event": [
              {
                "event_id": 1,
                "event_name": "Initial Event",
                "event_payout_type": "CPC",
                "event_payout": "2",
                "event_percent_payout": "-1",
                "conversion_protocol": 2
              }
            ],
            "offer_vbt": "",
            "offer_geo": {
              "type": 1,
              "target": [

              ]
            },
            "offer_platform": {
              "target": [

              ]
            },
            "offer_cap": ""
          }
        ],
        "totalPages": 11,
        "totalRows": 21,
        "offset": 2,
        "limit": 2
      }
    }

results matching ""

    No results matching ""