getOfferById
The Method is not recommended, and you can use getOffers
1.1.1 Summary
Get offer details for affiliate.1.1.2 Request
Request Method: GETParameters:
Parameter | Description | Type | Data Range |
key |
Network API Key; *Required |
string | |
a |
Affiliate ID *Required |
Int | Single value |
id |
Offer ID *Required |
Int | Multi-select, separated by commas |
1.1.3 Response
Header:
HTTP Status | Object | Description | Error Code |
200 | Success | 0 | |
400 |
Parameter Affiliate ID | No Affiliate ID | 6021 |
Affiliate ID Not Match API Key | 6022 | ||
Affiliate Not Exist | 6023 | ||
Parameter Offer ID | Invalid Offer | 6601 | |
Affiliate cannot access to this offer | 6602 |
Content Format: JSON
Data is array of offers; each offer is a JSON object.
Offer Property | Description |
id | Offer ID |
name | Offer Name |
status | Offer Status |
create_date | Offer Created Date (YYYY/MM/DD) |
expire_date | Offer Expire Date (YYYY/MM/DD) |
type | Offer Type |
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) |
payout_percent | Payout Percent (CPS) |
logo | Offer Logo Image Path |
screenshot | Offer Screen shot Image Path |
description | Offer Description |
restriction | Offer Restriction |
access_type | Offer Access Type |
session_lifespan | Offer Click Session Lifespan |
has_cap_limit | Using CAP to Limit Conversion or not |
cap_range | Cap Range |
cap_type | 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 |
enable_geo_targeting | Using GEO Targeting or not |
geo_type | Include or Exclude |
geo_countries | Countries |
geo_states | States |
enable_device_targeting | Using Device Targeting or not |
device_rules |
Device rules array: Each Device rule string has three parts to make up a string, which includes enable/disable, param name and parameter list. Each string uses colons as delimiter. If the param list contains multiple params, use semicolon to separate them. Example: “1:OS:iOS;Windows phone” means allowed Device OS types are iOS and windows phone. |
events | |
id | Offer Event Unique Id |
e_id | Id in Offer |
event_name | Event Name |
e_tkn | Event Token |
pre_event_id | The predecessor event id |
description | The description of event |
tracking_method | Conversion Tracking Protocol |
is_end_point | Whether the event is end point. |
payout_type | The payout type of event |
payout |
The payout of event "-1.000" indicates that the payout is not set. |
payout_percent | The payout 2 of event. Only when payout type is CPS or CPA + CPS. "-1.000" indicates that the payout percent is not set. |
can_multiply_conversion | Whether the event can multiple conversion. |
conversion_point | Conversion Point |
1.1.4 Example
Sample Request URL:http://{Your_Network_Domain}/api/v1/getOfferById?key=Aj0CDE889012&a=2&id=5
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, "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" ], "payout": "8", "events" : [ { "id" : "1", "e_id" : "1", "event_name" : "1", "e_tkn" : "3", "pre_event_id" : "-1", "description" : "2", "tracking_method" : "iFrame Pixel", "is_end_point" : "No", "payout_type" : "CPA", "payout" : "435.000", "can_multiply_conversion" : "Yes", "conversion_point" : "", } ] } ], "errorCode": 0, "message": "" } |
Close All
API V3
API V2
-
User - Network
-
User - Affiliate
-
Offer
-
Report
-
Dictionary
API V1 (DEPRECATED)