getOffer
1.1 Summary
Get offer information1.2 Request
Request Method: get
Request Parameters:
Parameter | Description | Type | Data Range |
Key |
Network API Key; *Required |
String | |
page | Page Number | Integer | 500(Default)/1000/5000/10000 |
limit | Limit per page | Integer | |
status | Filter by offer status | String | Active/pending/paused/archived.Single status is allowed. |
country | Filter by country | String | CN,US, etc. Single country is allowed. |
event_info | Show event info. 0: don't show Event info; 1: show Event info | Integer | 0,1 |
geo_info | Show event info. 0: don't show GEO info; 1: show GEO info | Integer | 0,1 |
device_info | Show event info. 0: don't show device info; 1: show device info | Integer | 0,1 |
cap_info | Show event info. 0: don't show cap info; 1: show cap info | Integer | 0,1 |
1.3 Response
Header:
HTTP Status | Object | Description | Error Code |
202 | Request | Success | 0 |
1.4 Example
Request Sample:
/api/v1/getOffer?key=kkkkkkkkeeeeyyyyyy&limit=500&page=1&cap_info=1&device_info=1&geo_info=1&event_info=1&country=CN&status=pending
/api/v1/getOffer?key=kkkkkkkkeeeeyyyyyy&limit=500&page=1&cap_info=1&device_info=1&geo_info=1&event_info=1&offer_ids=18679,18678
Response Sample:
{
"httpStatus": 200,
"errorCode": 0,
"errorMessage": "",
"data": [
{
"id": 18679,
"name": "test",
"status": "Pending",
"advertiser_id": 11,
"create_date": "2017/07/04",
"expire_date": "2018/07/03",
"type": "Mobile",
"access_type": "Public",
"session_lifespan": "1 Month",
"preview_url": "http://www.baidu.com",
"url": "http://www.baidu.com?tid={TID}",
"secondary_offer": "",
"force_unique": "No",
"need_security_token": "No",
"has_cap_limit": "No",
"cap_type": "Budget",
"cap_overall_limit": -1,
"cap_interval": "",
"cap_interval_limit": -1,
"cap_affiliate_overall_limit": -1,
"cap_affiliate_interval": "",
"cap_affiliate_interval_limit": -1,
"enable_device_targeting": "No",
"device_redirect_offer": "",
"device_rules": [],
"enable_geo_targeting": "No",
"geo_type": "Include",
"geo_countries": "",
"geo_redirect_offer": "",
"geo_redirect_group": "",
"geo_enforce": "Disable",
"geo_states": [],
"currency": "Japan, Yen",
"currency_code": "33",
"price_model": "CPA",
"payout_type": "CPA",
"revenue_type": "RPA",
"payout": "1.00000",
"revenue": "2.00000",
"events": [
{
"id": 19213,
"e_id": 1,
"event_name": "InitialEvent",
"e_tkn": "",
"pre_event_id": -1,
"description": "",
"status": "Active",
"is_end_point": "No",
"revenue_type": "RPA",
"payout_type": "CPA",
"is_private": "No",
"payout": "1.00000",
"revenue": "2.00000",
"can_multiply_conversion": "No",
"need_approval": "No",
"conversion_point": ""
}
]
},
{
"id": 18678,
"name": "Offer_0_CreatedAt1499157899847",
"status": "Active",
"advertiser_id": 1,
"create_date": "2017/07/04",
"expire_date": "2019/10/07",
"type": "Mobile",
"access_type": "Public",
"session_lifespan": "2 Weeks",
"preview_url": "http://www.baidu.com",
"url": "http://www.baidu.com?tid={TID}",
"secondary_offer": 2,
"force_unique": "Yes",
"need_security_token": "No",
"has_cap_limit": "No",
"cap_type": "Budget",
"cap_overall_limit": -1,
"cap_interval": "",
"cap_interval_limit": -1,
"cap_affiliate_overall_limit": -1,
"cap_affiliate_interval": "",
"cap_affiliate_interval_limit": -1,
"enable_device_targeting": "No",
"device_redirect_offer": "",
"device_rules": [],
"enable_geo_targeting": "No",
"geo_type": "Include",
"geo_countries": "",
"geo_redirect_offer": "",
"geo_redirect_group": "",
"geo_enforce": "Disable",
"geo_states": [],
"currency": "Euro",
"currency_code": "2",
"price_model": "CPA",
"payout_type": "CPA",
"revenue_type": "RPA+RPS",
"payout": "1.12300",
"revenue": "2.23500",
"events": [
{
"id": 19212,
"e_id": 1,
"event_name": "InitialEvent",
"e_tkn": "",
"pre_event_id": -1,
"description": "",
"status": "Active",
"is_end_point": "No",
"revenue_type": "RPA+RPS",
"payout_type": "CPA",
"is_private": "No",
"payout": "1.12300",
"revenue": "2.23500",
"revenue_pencent": "2.23500",
"can_multiply_conversion": "No",
"need_approval": "No",
"conversion_point": "DOI"
}
]
}
],
"page": 1,
"totalPages": 1,
"totalItems": 2
}
Close All
API V3
API V2
-
User - Network
-
User - Affiliate
-
Offer
-
Report
-
Dictionary
API V1 (DEPRECATED)