HugOffers API Documents
1. Introduction
This document will introduce HugOffers API (hereinafter referred to as API). Advanced partners can get campaign information by calling API .
HugOffers API is built on HTTP protocol, using GET / POST way to obtain the response content. Notably, to call our API, please contact with your account manager to get your API Key for authentication. Since anyone can conduct API request on your account’s behalf with the API Key, please keep your API Key confidential.
2. Get Campaign List
This interface will provide a list of promoted campaigns and all related information. The return value is a json.
Note:
This interface is case sensitive and you must distinguish campaigns by yourself.
2.1 Query Params:
Get
GET http://{cid}.hoapi0.com/v1?cid={Customer_id}&token={Token}
Please contact your account manager to get your unique request URL.
Path Parameters
token
string
Unique key
cid
string
Customer id
page
string
Pagesize,current page .eg:page=10,1
return
string
Default json
geo
string
Filter by geo value, muti-geo should be implode by",",eg:geo=es,vn
platform
string
Default:all devices
2.2 Response
Parameters
Description
total_offers_num
Total offers counts
max_page
Maximum page
page
Current page
offers_num_this_page
Rows of current page
success
true or false
offers
refer to offer data
2.3 Offer Data
Parameter
Description
Possible Value
Allow Multiple Value
Sample
campid
Campaign ID
int number
No
10
offer_name
Campaign Name
string
No
PMobo Market - TH
status
The status of the campaign
running
No
running
platform
Allowed OS
Android, iOS, PC Others
No
Android
tracking_link
Tracking link
url
No
https://{cid}. hotrk0.com/offer?offer_id=354634&aff_id=91&aff_sub={click_id}&aff_pub={source}&advertising_id={advertising_id}&idfa={idfa}
geo
Allowed countries
refer to appendix
Yes, multiple values separated by comma without space
DE,NO,FI
preview_link
Preview link
url
No
https://play.google.com/ store/apps/details?id=com.zpy.android.mm
price
Payout for channel Default currency is dollar ($)
Floating number with two
significant figure
No
1.85
price_model
Pricing mode
cpc,cpi,cpa
No
cpi
app_category
Campaign categories
Refer to appendix
Yes,multiple values separated by comma without space
Game,Subscr iption
start_time
Unix time stamp
1550743682
No
1550743682
start_date
Time of campaign beginning to run
xxxx-xx-xx xx:xx
No
2019-02-21T10:08:02+0000
end_time
Unix time stamp
1582279682
No
1582279682
end_date
Time of campaign being paused; null means long
term;
xxxx-xx-xx xx:xx
No
2020-02-21T10:08:02+0000
update_time
The last time when the information associated with this Campaign ID
being Modified,unix timestamp
1553499459
No
1553499459
update_date
The last time when the information associated with this Campaign ID
being modified.
xxxx-xx-xx xx:xx
No
2019-03-25T07:37:39+0000
effective_time
Time of enabling campaign modification
Unix timestamp
1419782400
No
1419782400
effective_date
Time of enabling campaign modification
xxxx-xx-xx xx:xx
No
2019-02-21T10:08:02+0000
exclude_device
Device models NOT allowed to show this campaign.
string
Yes, multiple values separated by comma without space
samsung,son y
exclude_site
Sites NOT allowed to run the campaign
string
Yes, multiple values separated by comma without space
songs.pk
carriers
Target carriers
string
Yes, multiple values separated by comma without space
Digi,Maxis, Celcom
daily_cap
daily max conversion
null or int number
No
12000
icon_link
Usually is the the
link where
we can get the icon url
string
No
http:// testHugoffers.com
/yandexicon96
.png
creative_link
Usually is the list of the
data where
we can get the image url, and the width and height
json
Yes, multiple values with json format
[{"url":"http:// testHugoffers.com
/123456.jpg",
"width":1200,"height":627}]
video_link
Usually is the list of the
data where
we can get the video url, video duration, width and height
json
Yes, multiple values with json format, duration is the video length in second
[{"url":"http:// testHugoffers.com
/65432.mp4",
"duration":30, "width":800,"height":600}]
app_name
App Name
string
No
Poker Texas Polski
app_desc
App Description
string
No
Poker Texas online
app_size
App size. Default unit is MB
floating number with one significant figure
No
3.7
app_rate
App rate in google play
floating number with one significant figure
No
4.3
app_id
bundle id in appstore or package name in google play
string
No
944846798
min_android_ version
Allowed min Android
version if the platform is Android.
refer to appendix
No
1.1
max_android_ version
Allowed max Android
version if the platform is Android.
refer to appendix
No
5.0
min_ios_version
Allowed max iOS
version if the platform is iOS.
refer to appendix
No
2.0
max_ios_version
Allowed max iOS
version if the platform is iOS.
refer to appendix
No
8.0
requirement_traffic
Traffic reqirement.
“null” means all kinds of traffic allowed
refer to appendix
Yes, multiple values separated by comma without space
Incent no allowe Adult no Allowed,
performance_criteria
kpi
kpi
Yes
Second day retention rate above 35%
white_source
whitelist,format: “mid_publisher_pubid_subid”
string
Yes, multiple values separated by comma without space
2425_10323,2425_10215
black_source
blacklist,format: “mid_publisher_pubid_subid”
string
Yes, multiple values separated by comma without space
2500_4781,2500_4588
impression_link
Impression_link
url
No
https://{cid}. hoimp0.com/imp?offer_id=354634&aff_id=91&aff_sub={click_id}&aff_pub={source}&advertising_id={advertising_id}&idfa={idfa}
Note1:
You may not receive the following four parameters, “min_android_version”,
“max_android_version”, “min_ios_version” and “max_ios_version”, at the same time. If “platform” is Android, you will only receive “min_android_version” and “max_android_version”. Otherwise, you will only receive “min_ios_version” and “max_ios_version”.
Note2:
“campid” is our campaign’s unique index. Our “tracking_link” may be changed, due to the server migration. So if you use “tracking_link” to match campaign information requested by API to which you’ve received from us before, please refer to the below string, part of “tracking_link”, which does not change during campaign’s life time.
354634 remains the same during campaign’s flight time.
e.g.:
https://{cid}.hotrk0.com/offer?offer_id=354634&aff_id=91&aff_sub=[click_id]&aff_pub=[source]&advertising_id=[advertising_id]&idfa=[idfa]
2.3 example
{
total_offers_num: 1,
max_page: 1,
page: 1,
offers_num_this_page: 1,
success: true,
offers: [
{
campid: "354634",
offer_name: "tap4fun_Spartanwars_ru",
status: "running",
platform: "Android",
tracking_link:"https://{cid}.hotrk0.com/offer?offer_id=354634&aff_id=91&aff_sub=[click_id]&aff_pub=[source]&advertising_id=[advertising_id]",
geo: "MY",
preview_link:"https://play.google.com/store/apps/details?id=com.tap4fun.spartanwar", price: 1,
price_model: "cpi",
app_category: "Game",
start_time: "1553498486",
start_date: "2019-03-25T07:21:26+0000",
end_time: "1585034486",
end_date: "2020-03-24T07:21:26+0000",
update_time: "1553502101",
update_date: "2019-03-25T08:21:41+0000",
effective_time: "1553498486",
effective_date: "2019-03-25T07:21:26+0000",
exclude_device: "",
exclude_site: "0",
carriers: "",
daily_cap: 100,
icon_link: "https://lh3.googleusercontent.com/rZkpGk1TcmElfKXLC_NZldKGW8rPPngTuTfmJ 9Z7SfF_Qy6vN1u4Ymy3JzNIQ9e9ZqN3=w300",
creatives_link: [{"url":"http://hugoffers.com/1.jpg","width":1200,"height":627},
{"url":"http://test.hugoffers.com/2.jpg","width":640,"height":100}]
video_link:[ {"url":"http://testhugoffers.com/4.mp4","duration":30,"width":1200,"height":627},{"url":"http://testhugoffers.com/5.jpg","duration":15,"width":640,"height":100}]
app_name: "",
app_desc: "",
app_size: "0",
app_rate: "0",
app_id: "com.tap4fun.spartanwar",
min_android_version: "",
max_android_version: "",
min_ios_version:"5.0",
max_ios_version:"",
requirement_traffic:"non-incent",
performance_criteria:"kpi details",
white_source:"",
black_source:"",
Impression_link:""
}
]
}
3.Tracking Parameters
aff_sub
String
affiliate/publisher click id
offer_id
String
ID of offer.
aff_id
String
ID of unique affiliate/publisher
aff_pub
String
Sub source id/sub id
idfa
String
Apple's advertiser identifier with iOS 6+.
advertising_id
String
Google's advertising identifier,gaid
ip
String
IP address that made the click request.
event_name
String
Event Name
android_id
String
Android Device ID.
user_agent
String
User Agent In Header.
site_id
String
app id,package name,website url (App/Website)
aff_lang
String
Device two-character language code.
4.Postback format
Tracking Parameters
Type
Description
offer_id
String
ID of offer.
aff_id
String
ID of publisher.
aff_pub
String
Sub source id/sub id
aff_sub
String
affiliate/publisher click id
aff_sub2
String
affiliate/publisher sub 2 Custom parameter
aff_sub3
String
affiliate/publisher sub 3 Custom parameter
aff_sub4
String
affiliate/publisher sub 4 Custom parameter
aff_sub5
String
affiliate/publisher sub 5 Custom parameter
aff_sub6
String
affiliate/publisher sub 6 Custom parameter
payout
String
Amount paid to publisher for conversion.
idfa
String
Apple's advertiser identifier with iOS 6+.
advertising_id
String
Google's advertising identifier,gaid
ip
String
IP address that made the click request.
event_name
String
Event Name
android_id
String
Android Device ID.
user_agent
String
User Agent In Header.
site_id
String
app id,package name,website url (App/Website)
Last updated
Was this helpful?