Get complete Offer details by Offer ID
URL
http://[platform_URL]/api/affiliate/get-offer-info
Parameters
| Field Name | Required | Description |
|---|---|---|
| api-key | Yes | Ask your Manager for API activation. API Key could be found on your Profile page. |
| offer_id | Yes | Offer ID |
| langnew | No | Set the language code for Geonames ("en", "ru" etc.) |
Output Parameters
| Field Name | Description |
|---|---|
| id | The offer ID |
| name | Offer's title |
| image | Offer's logo image URL |
| "status": { "id": "3", "name": "Live" } |
Offer's status (1=Testing, 3=Active, 4=Inactive) |
| "categories": { "ids": "7, 35, 9, 24", "titles": "Food & Gifts, Entertainment, Health & Beauty, Other" } |
Offer's categories IDs and titles (deprecated field, left for compatibility, please use tags instead) |
| "tags": { "ids": "7, 35, 9, 24", "titles": "Food & Gifts, Entertainment, Health & Beauty, Other" } |
Offer's tags IDs and titles |
| notes | Offer notes |
| mediaTypes | Offer's media types Note: you may have other custom set of media types in your platform |
| trafficAllowed | Traffic Type: NonIncent, Incentive |
| "currency": { "currencySymbol": "USD", "currencyPosition": "before" } |
The currency code and the currency symbol's position |
| Targeting Block | |
| "geoTargeting": { "id": 0, "limitation": "None", "type": "", "gt_include_ids": "3346015,3039678", "gt_exclude_ids": "3186717", "geotargeting_allowed_tooltip": "Allowed Geo", "geotargeting_allowed": "Ordino (Andorra), Sumbe (Angola)", "geotargeting_denied_tooltip": "Denied Geo", "geotargeting_denied": "Zavidovici (Bosnia and Herzegovina)" } |
Offer's allowed and denied Geonames IDs and titles. Geo IDs of particular countries, regions, cities can be found here: https://www.geonames.org |
| "connectionTypeTargeting": { "id": 2, "connectionType": "Mobile Internet", "mobileOperators": "" } |
Offer's allowed connection type IDs and titles |
| "deviceTypeTargeting": { "id": "2", "deviceType": "Mobile", "mobileOsId": "1", "mobileOs": "iOS" } |
Offer's allowed device type IDs and titles |
| trackingUrl | Offer's tracking URL |
| Goals block | |
| name | Goal title |
| offer_id | Parent Offer ID |
| type | Goal's type (1=CPC, 2=CPA, 3=CPL, 4=CPS, 5=CPI) |
| payout | Payout for Affiliate |
| dcap | Daily cap |
| tcap | Monthly cap |
| total_cap | Total cap |
| notes | Goal's notes |
| Creatives block | |
| id | Creative ID |
| name | Creative title |
| "type": { "id": "1", "name": "Banners" } |
Creative's type ID and title |
| "status": { "id": "1", "name": "Active" } |
Creative's status ID and title |
| emailSubjects | Email creative's subjects |
| emailFrom | Email creative's "From" email address |
| emailBody | Email creative's body |
| emailText | Email creative's plain text |
| "size": { "width": "150", "height": "150", "sizeToText": "150x150, 10.20" } |
Banner creative info: size , width, height |
| image | Creative image URL |
| notes | Creative's notes |
| trackingUrl | Creatives tracking URL |
| htmlCode | Creative's HTML |
| offerId | Parent Offer ID |
Sample
Request
http://demo.scaleo-up.com/api/affiliate/get-offer-info?api-key=4464ff1275ff448303ef9bb56e6b6e31aebf6e12&offer_id=33
Response
{
"status": 200,
"code": 0,
"name": "OK",
"offerInfo": {
"id": "33",
"name": "Burger",
"image": "https://s3.eu-central-1.amazonaws.com/storage.scaleo-up.com/affiliate/offers/5a2ababd54983.jpg",
"status": {
"id": "3",
"name": "Live"
},
"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"
},
"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>",
"mediaTypes": "Banners, E-mail, Social Media",
"trafficAllowed": "NonIncent",
"goals": [
{
"name": "CPA approved",
"offer_id": "33",
"type": "2",
"payout": "0.60",
"dcap": "10",
"tcap": "0",
"total_cap": "1004",
"notes": "Yooooo!"
},
{
"name": "CPL approved",
"offer_id": "33",
"type": "3",
"payout": "1.50",
"dcap": "0",
"tcap": "0",
"total_cap": "0",
"notes": "This is the default goal!"
},
{
"name": "CPI approved",
"offer_id": "33",
"type": "5",
"payout": "10.00",
"dcap": "0",
"tcap": "102",
"total_cap": "0",
"notes": null
}
],
"currency": {
"currencySymbol": "USD",
"currencyPosition": "before"
},
"targeting": {
"geoTargeting": {
"id": 0,
"limitation": "None",
"type": "",
"gt_include_ids": "3346015,3039678",
"gt_exclude_ids": "3186717",
"geotargeting_allowed_tooltip": "Allowed Geo",
"geotargeting_allowed": "Ordino (Andorra), Sumbe (Angola)",
"geotargeting_denied_tooltip": "Denied Geo",
"geotargeting_denied": "Zavidovici (Bosnia and Herzegovina)"
},
"connectionTypeTargeting": {
"id": 2,
"connectionType": "Mobile Internet",
"mobileOperators": "O2 (DE)"
},
"deviceTypeTargeting": {
"id": "2",
"deviceType": "Mobile",
"mobileOsId": "1",
"mobileOs": "iOS"
}
},
"trackingUrl": "http://demo.scaleo-up.com/click?offer_id=33&affiliate_id=60&creative_id=0&sub_id1="
},
"creativesInfo": {
"banners": {
"title": "Image Banners",
"count": 1,
"items": [
{
"id": "11",
"name": "Main",
"type": {
"id": "1",
"name": "Banners"
},
"status": {
"id": "1",
"name": "Active"
},
"size": {
"width": "150",
"height": "150",
"sizeToText": "150x150, 10.20"
},
"image": "https://s3.eu-central-1.amazonaws.com/storage.scaleo-up.com/affiliate/creatives/5a2ee9ee4025d.jpg",
"notes": "",
"trackingUrl": "http://demo.scaleo-up.com/click?offer_id=33&affiliate_id=60&creative_id=11&sub_id1=",
"htmlCode": "<a href=\"http://demo.scaleo-up.com/click?offer_id=33&affiliate_id=60&creative_id=11&sub_id1=&source_id={source_id}\" target=\"_blank\"><img src=\"http://demo.scaleo-up.com/tracking/creatives/11/60\" width=\"150\" height=\"150\" border=\"0\"/></a>",
"offerId": "33"
},
"emails": {
"title": "Emails",
"count": 1,
"items": [
{
"id": "18",
"name": "Some email here",
"type": {
"id": "2",
"name": "HTML / Text"
},
"status": {
"id": "1",
"name": "Active"
},
"emailSubjects": "Test",
"emailFrom": "test@gmail.com",
"emailBody": "HTML code here<img src=\"http://demo.scaleo-up.com/tracking/creatives/18/60\" width=\"0\" height=\"0\" border=\"0\"/>",
"emailText": "Some plain text",
"notes": "Description for the email",
"trackingUrl": "http://demo.scaleo-up.com/click?offer_id=33&affiliate_id=60&creative_id=18&sub_id1=",
"htmlCode": "HTML code here<img src=\"http://demo.scaleo-up.com/tracking/creatives/18/60\" width=\"0\" height=\"0\" border=\"0\"/>"
}
]
}
}
}