Get complete Offer details by Offer ID
URL
http://[platform_URL]/api/manager/get-offer-details/[Offer_ID]
Input Parameters
| Field Name | Required | Description |
|---|---|---|
| api-key | Yes | Ask your Admin for API activation. API Key could be found on your Profile page. |
| langnew | No | Set the language code for Geonames ("en", "ru" etc.) |
Output Parameters
| Field Name | Description |
|---|---|
| id | The offer ID |
| name | Offer's title |
| redirect_url | The Landing Page URL |
| end_date | - |
| c_lifespan | Cookie Life Time (days) |
| opip | - |
| avail_type | Offer's availability type (1=For all, 2=By request, 3=Selectively) |
| avail_action | - |
| notes | Offer's notes |
| notes_admin | - |
| image | Offer's logo image file name |
| exclusive | - |
| redirect_mode | - |
| added | The date of adding the offer (format: yyyy-mm-dd hh:mm:ss) |
| integration_visible | - |
| hide_referer_url | Hide Referrer URL (1=hide, 0=do not hide) |
| gt_included_ids | Included geonames IDs. Geo IDs of particular countries, regions, cities can be found here: https://www.geonames.org |
| gt_excluded_ids | Excluded geonames IDs. Geo IDs of particular countries, regions, cities can be found here: https://www.geonames.org |
| gt_filter | - |
| across_all_affiliates | - |
| validation_type | - |
| whitelist_ips_for_postbacks | Whitelist IPs for Postbacks (for S2S tracking only) |
| blacklist_ips_for_postbacks | Blacklist IPs for Postbacks (for S2S tracking only) |
| payment_amount_basic_to_show | - |
| payment_amount_premium_to_show | - |
| deep_linking | Deep linking for Affiliates (0=Not allowed, 1=allowed) |
| deep_linking_notes | Deep linking notes, description, visible for affiliates |
| device_targeting | Device targeting (0=None, 1=Desktop, 2=Mobile |
| mobile_os | (0=All, 1=iOS, 2=Android, 3=Windows Phone) |
| force_rotation | Force Rotation, ignore Offer Main Landing Page URL (0=Switched Off, 1=Switched On) |
| connection_type | Connection type (0=None, 1=WiFi / Cable / DSL / Other, 2=Mobile Internet) |
| mobile_operators | Mobile Operator IDs |
| traffic_type_redirection | Inappropriate Traffic (1=Redirect according to Advanced Rules or Global Redirect, 2=Redirect to Offer URL, ignore conversions) |
| tracking_domain_id | - |
| featured | Featured offer (1=Yes, 2=No) |
| default_goal_id | Default Goal ID |
| desktop_os | Desktop OS ID |
| geotargeting_allowed_tooltip | The tooltip for Allowed Geo |
| geotargeting_allowed | Titles of selected Geo items |
| geotargeting_denied_tooltip | The tooltip for Allowed Geo |
| geotargeting_denied | Titles of selected Geo items |
| click_goal_id | Click Goal ID |
| eCPC | Effective cost per click value |
| "status": { "id": "3", "title": "Active" } |
Offer's status (1=Testing, 3=Active, 4=Inactive) |
| "advertiser": { "id": "63", "name": "Costa LTD" } |
The Advertiser's ID and name |
| "categories": { "ids": "7, 35, 9, 24", "titles": "Food & Gifts, Entertainment, Health & Beauty, Other" |
Selected categories titles with IDs (deprecated field, left for compatibility, please use tags instead) |
| "tags": { "ids": "7, 35, 9, 24", "titles": "Food & Gifts, Entertainment, Health & Beauty, Other" |
Selected tags titles with IDs |
| tracking_domain | - |
| "mediaTypes": { "ids": "1,2,3,4", "titles": "Banners, E-mail, Search, Social Media" } |
Offer's selected media types: IDs with titles Note: you may have other custom set of media types in your platform |
| trafficAllowed | Traffic Type: NonIncent, Incentive |
| Creatives block | |
| id | Creative ID |
| name | Creative name |
| description | Creative description |
| "status": { "id": 1, "title": "Active" } |
Creative status |
| "banner": { "size": "200x200, 3.73", "width": "200", "height": "200", "filename": "589b1747bbc49.png" } |
Banner creative info: size, width, height, the filename |
| "email": { "subjects": "Some test title here", "from": "test@gmail.com", "asHtml": "HTML code here" } |
Email creative info: subjects, "from", HTML code |
| countImpressions | Count impression for the "Other": creative type (ON=count, OFF=do not count |
| trackingUrl | The creative's tracking URL |
| htmlCode | The creative's HTML code |
| Goals block | |
| id | Goal ID |
| name | Goal title |
| conversion_status | Leads status after conversion (1=Approved, 2=Pending) |
| offer_id | Parent Offer ID |
| type | Goal's type (1=CPC, 2=CPA, 3=CPL, 4=CPS, 5=CPI) |
| bounty | Payout from the Advertiser |
| payout_basic | Payout for Affiliate (basic) |
| payout_premium | Payout for Affiliate (premium) |
| dcap | Daily cap |
| tcap | Monthly cap |
| total_cap | Total cap |
| using_pending_dcap | Count Pending transactions for Daily cap (1=count, 2=do not count) |
| using_pending_tcap | Count Pending transactions for Monthly cap (1=count, 2=do not count) |
| using_pending_total_cap | Count Pending transactions for Total cap (1=count, 2=do not count) |
| tracking_type | Type of tracking (1=Cookie based, 2=S2S tracking) |
| pixel_type | Pixel's type (1=IFRAME, 2=IMG) |
| tracking_code | Goal's tracking code |
| notes | Goal's notes |
| allow_multiple_conversions | Allow multiple conversions (1=Allow, 2=Do not allow) |
| fire_aff_pixels | Affiliates postback pixels firing upon the conversion (1=Allow, 2=Do not allow) |
| unique_track_id | Unique Track ID (1=Yes, 2=No) |
| order | Goal's order ID in the list |
| goal_status | Goal's status (1=Active, 2=Inactive) |
Sample
Request
http://demo.scaleo-up.com/api/manager/get-offer-details/33?api-key=9eb500a476603546a779e6418117ef0403aa3f64
Response
{
"code": 0,
"status": 200,
"offerInfo": {
"id": "33",
"name": "Burger",
"redirect_url": "https://www.scaleo.io/?oid={offer_id}&aid={affiliate_id}&cl={click_id}&page=MAIN&sid={sub_id1}_{sub_id2}_{sub_id3}_{sub_id4}_{sub_id5}",
"end_date": "0000-00-00 00:00:00",
"c_lifespan": "7",
"opip": "0",
"avail_type": "1",
"avail_action": "0",
"notes": "<div style=\"text-align: center;\"><b>Taste that!</b></div><div style=\"text-align: center;\"><b><br></b></div><div style=\"text-align: center;\"><img src=\"https://images.fastcompany.net/image/upload/w_596,c_limit,q_auto:best,f_auto,fl_lossy/wp-cms/uploads/2017/06/i-1-sonic-burger.jpg\" width=\"200\"><br></div>",
"notes_admin": null,
"image": "5a2ababd54983.jpg",
"exclusive": "0",
"redirect_mode": "0",
"added": "2017-12-08 18:15:57",
"integration_visible": "1",
"hide_referer_url": "0",
"gt_included_ids": "690791,2017370",
"gt_excluded_ids": "690791,2017370",
"gt_filter": "",
"across_all_affiliates": "0",
"validation_type": "0",
"whitelist_ips_for_postbacks": "",
"blacklist_ips_for_postbacks": "",
"payment_amount_basic_to_show": "0",
"payment_amount_premium_to_show": "0",
"deep_linking": "0",
"deep_linking_notes": "",
"device_targeting": "0",
"mobile_os": "0",
"force_rotation": "0",
"connection_type": "0",
"mobile_operators": "",
"traffic_type_redirection": "1",
"tracking_domain_id": "0",
"featured": "1",
"default_goal_id": "108",
"desktop_os": "0",
"geotargeting_allowed_tooltip": "Allowed Geo",
"geotargeting_allowed": "Ukraine, Russian Federation",
"geotargeting_denied_tooltip": "Denied Geo",
"geotargeting_denied": "Ukraine, Russian Federation",
"click_goal_id": "103",
"eCPC": "7.9318181818182",
"status": {
"id": "3",
"title": "Active"
},
"advertiser": {
"id": "63",
"name": "Costa LTD"
},
"categories": {
"ids": "7, 35, 9, 24",
"titles": "Food & Gifts, Entertainment, Health & Beauty, Other"
},
"tags": {
"ids": "7, 35, 9, 24",
"titles": "Food & Gifts, Entertainment, Health & Beauty, Other"
},
"geo": {
"geoTargeting": "By Countries",
"geoTargetingType": "Deny selected Only",
"geoTargetingCountries": {
"NL": "Netherlands",
"GB": "United Kingdom",
"US": "United States of America"
},
"mediaTypes": {
"ids": "1,2,4",
"titles": "Banners, E-mail, Social Media"
},
"trafficAllowed": "NonIncent",
"creatives": {
"banners": {
"title": "Image Banners",
"count": 2,
"items": [
{
"id": "11",
"name": "Main",
"description": "",
"status": {
"id": 1,
"title": "Active"
},
"banner": {
"size": "150x150, 10.20",
"width": "150",
"height": "150",
"filename": "5a2ee9ee4025d.jpg"
},
"trackingUrl": "http://demo.scaleo-up.com/click?offer_id=33&affiliate_id={affiliate_id}&creative_id=11&sub_id1={sub_id1}",
"htmlCode": "<a href=\"http://demo.scaleo-up.com/click?offer_id=33&affiliate_id={affiliate_id}&creative_id=11&sub_id1={sub_id1}&source_id={source_id}\" target=\"_blank\"><img src=\"http://demo.scaleo-up.com/tracking/creatives/11/{affiliate_id}\" width=\"150\" height=\"150\" border=\"0\"/></a>"
},
"emails": {
"title": "HTML/Text",
"count": 0,
"items": [
]
},
"other": {
"title": "HTML/JavaScript",
"count": 0,
"items": [
]
}
},
"goals": [
{
"id": "103",
"name": "Clicks",
"conversion_status": "1",
"offer_id": "33",
"type": "1",
"bounty": "0.20",
"payout_basic": "0.10",
"payout_premium": "0.15",
"dcap": "0",
"tcap": "0",
"total_cap": "0",
"using_pending_dcap": "2",
"using_pending_tcap": "2",
"using_pending_total_cap": "2",
"tracking_type": "1",
"pixel_type": "1",
"tracking_code": "",
"notes": null,
"allow_multiple_conversions": "2",
"fire_aff_pixels": "2",
"unique_track_id": "2",
"order": "5",
"goal_status": 2
},
{
"id": "106",
"name": "CPA approved",
"conversion_status": "2",
"offer_id": "33",
"type": "2",
"bounty": "1.00",
"payout_basic": "0.60",
"payout_premium": "0.65",
"dcap": "10",
"tcap": "0",
"total_cap": "1004",
"using_pending_dcap": "1",
"using_pending_tcap": "2",
"using_pending_total_cap": "2",
"tracking_type": "1",
"pixel_type": "2",
"tracking_code": "<img src=\"http://demo.scaleo-up.com/track/goal-img?goal_id=106&track_id={track_id}\" height=\"1\" width=\"1\" />",
"notes": "Yooooo!",
"allow_multiple_conversions": "2",
"fire_aff_pixels": "1",
"unique_track_id": "1",
"order": "1",
"goal_status": 1
}
]
}
}