
API
API Response
Adscend Offers API Parameters
Your publisher ID pubID
, and API Key api_key
values are needed for every API call.
These values can be found at Offers API section of the publisher dashboard.
If you would like us to notify you whenever an offer is completed (lead generated), set up a server postback.
Offer API Response Details
Our offers API consists of a single API call which retrieves in JSON format a list of all of our available offers. By adding additional URL parameters to the API call URL you may sort, filter, and limit the offer returned in a variety of manners documentation for all of these options is provided in the pages listed under this in the left-hand navigation.
Response 204 when no offers are available for the given parameters.
Response 400 when required parameter not provided.
Response 403 when apikey
doesn't match the pubID
specified.
https://api.adscendmedia.com/v1/publisher/{pubId}/offers.json
Sample Response
{ "offers": [{ "offer_id": 225, "name": "Proflowers US", "adwall_name": "ProFlowers", "description": "Flowers from $19.99 + S&H with a free vase from Proflowers!", "allowed_traffic": "incent", "preview_url": "http://www.proflowers.com/vcur?ref=pfcaffilVCUREveryday_Adp&cvosrc=", "added": "2014-08-14 13:00:26", "end_date": "0000-00-00 00:00:00", "target_system": 50, "conversion_notes": "Credits are awarded with flowers ship, no cancellations.", "conversion_point": 4, "cost_to_user": -1, "video_url": null, "video_streaming_url": null, "video_streaming_ios_url": null, "leads_remaining": 0, "daily_lead_cap": null, "payout": 5.65, "payout_custom": 0, "stats_pending_network": 1, "epc_network": null, "conversion_rate_network": null, "stats_pending_adlock": 1, "epc_adlock": null, "conversion_rate_adlock": null, "stats_pending_adwall": 1, "epc_adwall": 2.13, "conversion_rate_adwall": 0.65, "auto_start": "2015-02-09 13:00:00", "auto_end": "2016-03-19 14:00:00", "product_id": [4], "category_id": [21], "countries": ["US", "IT", "AU"], "featured": 1, "credit_delay": 0, "events": [{ "event_id":1, "event_name":"Install", "event_description":"Install And Launch", "event_revenue":0.15 }, { "event_id":2, "event_name":"Reach_level_10", "event_description":"Reach level 10", "event_revenue":0.25 }], "creatives": [{ "id": 772, "camp_id": 225, "image_filename": "225-772.gif", "width": 125, "height": 125, "type": 1, "active": 1, "code": "", "tracking_url": "", "url": "http://asmclk.com/creat/225-772.gif" }], "click_url": "https://asmclk.com/click.php?aff=32836&camp=225&prod=9" }]
Response Legend
Key | Value |
---|---|
offer_id |
The offer's ID |
name |
The offer's name |
adwall_name |
Offer's name for offer wall product |
description |
Offer's description |
allowed_traffic |
0 = No Incentives, 1 = May incentivize except for points or cash, 2 = May incentivize with points, no cash incentives, 3 = May incentivize with points or cash |
preview_url |
Gives preview of landing page for an offer |
added |
Timestamp for when the offer was added to our inventory |
end_date |
Date the offer will be no longer active |
target_system |
ID representing the system this offer is targeted towards Possible values are: 0 = Any All 31 = Any Desktop: All, 10 = Windows: All, 11 = Windows: IE, 12 = Windows: Firefox, 13 = Windows: Chrome, 18 = Windows: FF or Chrome, 19 = Windows: All But Chrome, 20 = Mac: All, 30 = Any Mobile: All, 40 = Android: All, 56 = Android: 5.0 and above 50 = iOS: All, 51 = iOS: iPhone, 52 = iOS: iPad |
conversion_notes |
Notes about what is needed for end user to complete offer |
conversion_point |
ID representing action necessary for end user to complete offer: 1 = Email submit 2 = First page 3 = Second page 4 = Credit card submit 5 = SMS/PIN confirm 6 = Download 7 = Install 8 = Double opt-in 9 = Third page 10 = Fourth page 11 = After co-registration path 12 = Click 13 = Other 14 = Install and launch |
cost_to_user |
Cost for the end user to complete offer. -1 indicates the cost varies |
video_url |
If Rewarded Video offer, url to download video |
video_streaming_url |
If Rewarded Video offer, url to stream the video |
video_streaming_ios_url |
If Rewarded Video offer, ios enhanced stream of video |
leads_remaining |
Number of leads still available before offer get inactivated |
lifetime_lead_cap |
The limit on number of leads that can be generated for the offer before the offer is indefinitely inactivated. Value is null if there is no lifetime lead cap |
daily_lead_cap |
The limit on the number of leads that can be generated for the offer each day. Value is null if there is no daily lead cap |
payout |
Amount paid out to the affiliate/publisher when offer is completed by end user |
payout_custom |
Custom payout (if applicable for publisher, else is 0) |
stats_pending_network |
If returns 1, not enough stats have been accumulated to determine the EPC and CR for this offer |
epc_network |
Offer's Earnings Per Click across all products (If null, not enough stats to determine nework epc yet |
conversion_rate_network |
Offer's Conversion Rate across all products (If null, not enough stats to determine network conversion rate yet) |
stats_pending_adlock |
If returns 1, not enough stats have been accumulated to determine the EPC and CR for this offer used in AdLock products |
epc_adlock |
Offer's Earnings Per Click when used for AdLock products (If null, not enough stats to determine AdLock epc yet) | conversion_rate_adlock |
Offer's Conversion Rate when used for AdLock products (If null, not enough stats to determine the AdLock conversion rate yet) |
stats_pending_adwall |
If returns 1, not enough stats have been accumulated to determine the EPC and CR for this offer used in Offer Wall products | epc_adwall |
Offer's Earnings Per Click when used for Offer Wall (If null, not enough stats to determine Offer Wall epc yet) | conversion_rate_adwall |
Offer's Conversion Rate when used for Offer Wall (If null, not enough stats to determine Offer Wall conversion rate yet) |
auto_start |
Date and time the offer will be automatically set live |
auto_end |
Date and time the offer will automatically expire |
product_id |
Array of product IDs this offer is available for. 8 is Rewarded Video |
category_id |
Array of category IDs representing categories this offer is targeted towards | countries |
Array of 2 letter country codes this offer is available in |
creatives |
Array of creatives for the offer |
id |
ID of creative |
camp_id |
Offer ID this creative is used for |
image_filename |
File name for the creative |
width |
Width of the creative |
height |
Height of the creative |
type |
Type of creative. 1 = image, 2 = email (preview image), 3 = html(preview image), 4 = text |
active |
Flag to determine if offer is active. 1 = active and 0 = inactive |
code |
HTML code for an email creative (If applicable) |
tracking_url |
Tracking URL for specific creative for an offer, overrides default tracking URL (If applicable) |
url |
URL for the creative |
click_url |
The offer's click url which initiates offer
As You can see from Sample Response above, click_url has no 'sub1' GET param which is used
for user identification. You need to add it to click_url on your end.
You can use 4 additional optional GET params (
'sub2', 'sub3', 'sub4',
'device') for passing any values you need to receive back in postback.
Final click_url with custom GET parameters should be like this:
https://asmclk.com/click.php?aff=32836&camp=225&prod=9&sub1=[your_user_id]&sub2=[value_you_want]&sub3=[value_you_want]&sub4=[value_you_want]
How to receive back custom values in postback you can find here: postbacks
|
Events |
The offer's events if offer is multievent |
featured |
The featured offers. 1 for offer is featured and 0 for offer is not featured |
credit_delay |
Possible values are: 0 - instant 2* - days number (any number instead of 2) 2*-4* - day range (any numbers instead of 2 and 4) |