This article applies to customers who have the legacy version of Scaleo.
Please visit our new API Guide.
WARNING! This function will be updated in June 2019. Please use this one instead: get-offers-list
URL
http://[platform_URL]/api/manager/get-offers-list
Input Parameters
| Field Name | Required | Description |
|---|---|---|
| api-key | Yes | Ask your Admin for API activation. API Key could be found on your Profile page. |
| Offer[status_id] | Yes | Filter by Offer Status (1=Testing, 3=Active, 4=Inactive) |
| Offer[type] | Yes | Filter by Offer (goal) Type (1=CPC, 2=CPA, 3=CPL, 4=CPS, 5=CPI) |
| Offer[name] | No | Filter by Offer ID or Offer Name |
| Offer[tag_ids] | No | Filter by Tag ID |
| Offer[category_id] | No | Filter by Category ID (deprecated field, left for compatibility, please use Offer[tag_ids] instead) |
| Offer[media_types] | No | Filter by Media Type (1=Banners, 2=Emails, 3=Search, 4=SocialMedia) |
| Campaign[countries]= | No | Countries IDs, separated by comma |
| Campaign[advertisers]= | No | Advertisers IDs, separated by comma |
| page | No | The number of the page |
| per-page | No | The amount of records per the page |
Output Parameters
| Field Name | Description |
|---|---|
| id | The offer ID |
| name | Offer's title |
| advertiser_id | The Advertiser's ID for this offer |
| status_id | Offer's status (1=Testing, 3=Active, 4=Inactive) |
| default_goal_id | Default Goal ID |
| lp_url | - |
| media_types | Offer's selected media types (1=Banners, 2=Emails, 3=Search, 4=SocialMedia) Note: you may have other custom set of media types in your platform |
| 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 | - |
| traffic_type | Traffic Type (1=Non-Incentivized, 2=Incentivized) |
| 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_limitation | 0=None, 1=By countries, 2=By regions, 3=By cities |
| gt_type | Geo Targeting type (1=Allow selected only, 2=Deny selected only) |
| gt_countries | Geo Targeting: selected Countries IDs |
| gt_regions | Geo Targeting: selected Regions IDs |
| gt_cities | Geo Targeting: selected Cities IDs |
| gt_filter | Geo Targeting: countries IDs, which the geo filter is applied to |
| across_all_affiliates | - |
| lp_url_for_preview | - |
| 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 | - |
| eCPC | Effective cost per click value |
| geotargeting_tooltip | The tooltip for Geo Targeting type |
| geotargeting_value | Titles of selected Geo items |
| geo_tooltip_just_text | Titles of selected Geo items |
| countries_full | List with IDs of selected countries |
| countries_tooltip | Selected countries with geo targeting type |
| countries_tooltip_just_title | Geo targeting type |
| countries_tooltip_text | Selected countries with geo targeting type |
| selected_countries | List with IDs of selected countries |
| regions_tooltip_text | Selected regions with geo targeting type |
| regions_tooltip_just_title | Geo targeting type |
| regions_full | Selected regions with geo targeting type |
| cities_tooltip_text | Selected cities with geo targeting type |
| cities_tooltip_just_title | Geo targeting type |
| cities_full | Selected cities with geo targeting type |
| tags_inline | Selected tags titles |
| tags | List with IDs of selected tags |
| categories_inline | Selected categories titles (deprecated field, left for compatibility, please use tags instead) |
| categories | List with IDs of selected categories (deprecated field, left for compatibility, please use tags instead) |
| tracking_domain | - |
| click_goal_id | The Click goal ID |
| 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-offers-list?api-key=9eb500a476603546a779e6418117ef0403aa3f64&Offer[status_id]=3&Offer[type]=2
Response
[
{
"id": 33,
"name": "Burger",
"advertiser_id": 63,
"status_id": 3,
"default_goal_id": 108,
"lp_url": "",
"media_types": "1,2,4",
"end_date": "0000-00-00 00:00:00",
"c_lifespan": 7,
"opip": 0,
"avail_type": 1,
"avail_action": 0,
"traffic_type": 1,
"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_limitation": 0,
"gt_type": 1,
"gt_countries": null,
"gt_cities": null,
"gt_filter": "",
"across_all_affiliates": 0,
"lp_url_for_preview": null,
"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,
"eCPC": 7.9318181818182,
"geotargeting_tooltip": "",
"geotargeting_value": "",
"geo_tooltip_just_text": "",
"countries_full": "",
"countries_tooltip": "",
"countries_tooltip_just_title": "",
"countries_tooltip_text": "",
"selected_countries": "",
"regions_tooltip_text": "",
"regions_tooltip_just_title": "",
"regions_full": "",
"cities_tooltip_text": "",
"cities_tooltip_just_title": "",
"cities_full": "",
"categories_inline": "Food & Gifts, Entertainment, Health & Beauty, Other",
"categories": "7,35,9,24",
"tags_inline": "Food & Gifts, Entertainment, Health & Beauty, Other",
"tags": "7,35,9,24",
"tracking_domain": "",
"click_goal_id": 103,
"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
}
]
}
]