1.1.1 Summary

 
 Get information detail of one offer by offer ID  or by both offer ID  and offer status combination. If you want to get multiple offers, you can type a string of ID s and use comma as delimiter.
 

1.1.2 Request 

Request Method: GET
Parameters:
Parameter Description Type Data Range
key Network API Key;
*Required		 string  
id Offer ID
*Required		 int You can request a string of ID s and use comma as a delimiter, For ex:
1,5,6
status Offer Status;
Optional;
Default: All		 string All,
Archived, Active,
Pending, Paused, Expired
 

1.1.3 Response

Header:
HTTP Status Object Description Error Code
200 Request Success 0
 
400		 Parameter: ID No Offer ID 6301
Parameter: ID Invalid Offer ID 6302
Parameter: status Invalid Value of Offer Status 6303
 
Content Format: JSON.
Each offer is represented as a JSON code.
Variety of offers form an array of JSON.

Offer Property Description
id Offer ID
name Offer Name
status Offer Status
advertiser_id Advertiser ID
create_date Offer Created Date (YYYY/MM/DD)
expire_date Offer Expire Date (YYYY/MM/DD)
type Offer Type
categories Offer Categories
url Offer URL
preview_url Offer Preview URL
tracking_protocol Conversion Tracking Protocol
ssl Using SSL Tracking or not
conversion_point Conversion Point
currency Offer Currency
price_model Price Model
payout Payout (CPA, CPC)
revenue Revenue (CPA, CPC)
payout_percent Payout Percent (CPS)
revenue_percent Revenue Percent (CPS)
logo Offer Logo Image Path
screenshot Offer Screen shot Image Path
description Offer Description
restriction Offer Restriction
secondary_offer Secondary Offer ID
access_type Offer Access Type
session_lifespan Offer Click Session Lifespan
force_unique Using Unique ID  to Limit Conversion or not
need_security_token Using  Security Token to Security Conversion or not
enable_payout_tier Using Tier Payout Settings or not
tier_payout  Array Tier Payout
has_cap_limit Using CAP to Limit Conversion or not
cap_range Cap Range
cap_type CAP Type
cap_overall_limit Offer Overall CAP Limitation
cap_interval Interval CAP Type
cap_interval_limit Limitation for Interval CAP Type
cap_affiliate_overall_limit Affiliate Overall CAP Limitation of the Offer
cap_affiliate_interval Affiliate Interval CAP Type
cap_affiliate_interval_limit Limitation for Affiliate Interval CAP Type
allow_traffics Allows Traffics Array
enable_geo_targeting Using GEO Targeting or not
geo_type Include or Exclude
geo_countries Countries
geo_states States
 geo_enforce Enforce GEO or not
geo_redirect_offer Geo Redirect Offer ID
geo_redirect_group GEO Redirect Offer Group ID
enable_device_targeting Using Device Targeting or not
device_rules Device Rules
device_redirect_offer Device Redirect Offer ID
click_count -
last_click_time -
conversion_count -
last_conversion_time -
test_click_count -
last_test_click_time -
test_conversion_count -
last_test_conversion_time -
events Array of Offer Events
 

1.1.4 Example

Sample Request URL:
http://{Your_Network_Domain}/api/v1/getOfferById?key=603E3F0E3266&id=12
 
Response sample:
{
  "httpStatus": 200,
  "data": [
    {
      "id": "12",
      "name": "testoffer12",
      "create_date": "2015/02/13",
      "expire_date": "2015/02/26",
      "status": "Active",
      "type": "Tablet",
      "url": "http://6.cn?tid={TID}",
      "preview_url": "http://6.cn",
      "tracking_protocol": "Image Pixel",
      "ssl": "No",
      "conversion_point": "",
      "currency": " United States, Dollars",
      "price_model": "CPA",
      "logo": "",
      "screenshot": "",
      "description": "",
      "restriction": "",
      "access_type": "Public",
      "session_lifespan": null,
      "hide_referrer":"Yes",
      "enable_geo_targeting": "Yes",
      "geo_type": "Include",
      "geo_countries": "CN;NP",
      "enable_device_targeting": "Yes",
      "categories": [
        {
          "category_id": "1",
          "category_name": "Game"
        }
      ],
      "allow_traffics": [
        {
          "traffic_id": 1,
          "traffic_name": "Banner"
        },
        {
          "traffic_id": 2,
          "traffic_name": "Email"
        },
        {
          "traffic_id": 3,
          "traffic_name": "Facebook"
        },
        {
          "traffic_id": 4,
          "traffic_name": "Google"
        }
      ],
      "geo_states": [
        "CN:1:53;54",
        "NP:0:3;1"
      ],
      "device_rules": [
        "1:OS:iOS;Windows phone"
      ],
      "advertiser_id": "4",
      "payout": "8",
      "revenue": "9",
      "secondary_offer": "",
      "force_unique": "No",
      "need_security_token": "No",
      "enable_payout_tier": "Yes",
      "has_cap_limit": "Yes",
      "cap_type": "conversion",
      "cap_overall_limit": "100",
      "cap_interval": "Daily",
      "cap_interval_limit": "50",
      "cap_affiliate_overall_limit": "40",
      "cap_affiliate_interval": "Daily",
      "cap_affiliate_interval_limit": "20",
      "geo_enforce": "Enable",
      "geo_redirect_offer": "11",
      "geo_redirect_group": "",
      "device_redirect_offer": "11",
      "click_count": 0,
      "last_click_time": "",
      "conversion_count": 0,
      "last_conversion_time": "",
      "test_click_count": 0,
      "last_test_click_time": "",
      "test_conversion_count": 0,
      "last_test_conversion_time": 0,
      "tier_payout": [
        {
          "tier_id": 1,
          "payout": "100"
        },
        {
          "tier_id": 2,
          "payout": "200"
        },
        {
          "tier_id": 3,
          "payout": "300"
        }
      ],
"events": [
        {
          "id": "294",
          "e_id": "1",
          "event_name": "InitialEvent",
          "e_tkn": "",
          "pre_event_id": "-1",
          "description": "",
          "status": "Active",
          "tracking_method": "iFrame Pixel",
          "is_end_point": "False",
          "revenue_type": "RPA",
          "payout_type": "CPA",
          "is_private": "False",
          "revenue": "7.000",
          "payout": "2.000",
          "can_multiply_conversion": "False",
          "need_approval": "No",
          "conversion_point": "PIN-Submit"
        }
]
    }
  ],
  "errorCode": 0,
  "message": ""
}