Offers API
Last updated
Was this helpful?
Last updated
Was this helpful?
GET https://api.offer18.com/api/af/offers
Parameter
Type
Description
key
String
API Key
aid
Integer
Affiliate Id
mid
Integer
Your Advertiser MID
Query
Type
Description
offer_id
Integer
OfferID (&offer_id=000,001,002)
page
Integer
Page Number (&page=1)
category
String
Offer's category (&category=000,000,000)
model
String
Offer Model (&model=CPA,CPC)
country
String
Country Based Offers (&country=US, IN, AU)
offer_status
Integer
Allowed values: 1: Active offers (&offer_status=1)
authorized
Integer
Allowed values: 1: Assigned Offers (&authorized=1)
https://api.offer18.com/api/af/offers?key=000000000&aid=0000&mid=0000&offer_id=0000000&model=000
{
"response": "200",
"data": {
"00011": {
"offerid": "00011",
"name": "XXXXX",
"logo": "https://example.com/sample.jpeg/",
"status": "active",
"category": "download campaigns, gaming, subscription offers, Ecommerece Campaign",
"currency": "USD",
"price": 100,
"model": "CPA",
"date_start": "2019-05-09 02:19:00",
"date_end": "2021-08-31 02:19:00",
"preview_url": "https://www.example.com/?offerid=00011",
"offer_terms": "These are the offer terms",
"offer_kpi": "",
"country_allow": "IN,US",
"country_block": "GB",
"city_allow": "",
"city_block": "",
"os_allow": "",
"os_block": "",
"device_allow": "",
"device_block": "",
"isp_allow": "",
"isp_block": "",
"browser_allow": "",
"browser_block": "",
"capping": [
{
"rule_type": "shared_capping",
"event": "",
"type": "gross_conversions",
"period": "daily",
"value": 100,
"timezone": null,
"rule_id": "00000"
},
{
"rule_type": "affiliate_capping",
"event": "",
"type": "approved_conversions",
"period": "daily",
"value": 100,
"timezone": null,
"rule_id": "00000"
}
],
"events": [
{
"event_name": "registration",
"event_token": "registration"
}
],
"payout": [
{
"payout": "515.0000",
"currency": "USD",
"model": "CPA",
"condition": [
[
{
"field": "event",
"operator_type": "is_equal",
"value": "reagistration"
},
{
"field": "country",
"operator_type": "is_equal",
"value": "US"
},
{
"field": "device_type",
"operator_type": "is_equal",
"value": "smartphone"
},
{
"field": "browser",
"operator_type": "is_equal",
"value": "ch"
},
{
"field": "os",
"operator_type": "is_equal",
"value": "android"
}
]
],
"rule_id": "00000"
}
],
"suppression_list": [
{
"name": "Sample Suppression list",
"file_url": "https:\/\/storage.googleapis.com\/offer18-user-data\/suppression\/0000\/3dd0e00000f9202c8602b84feaf7_file.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=service-account%40offer18.iam.gserviceaccount.com%2F20250324%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250324T122057Z&X-Goog-Expires=172800&X-Goog-SignedHeaders=host&X-Goog-Signature=5ce353be3a209f62098d934b32b40d3af66b52a203ca821158c642a7c80c939af5bbad6435c2ce441b24e52df7f7bed4d4c54af8c4a8b54510c1dd7a55922ea49e52e1d1d4b6060000000653252a5d09c272f4748acf990c6eee95e166a87515fe984224fd587cf2c33d",
"unsubscribe_url": "https:\/\/example.com",
"subject_lines": "sample subject lines",
"from_lines": "sample from lines"
}
],
"impression_url": "https://mynet.o18.click/i?o=00011&m=000&a=00000",
"click_url": "https://mynet.o18.click/c?o=00011&m=000&a=00000",
"authorized": "true",
"creatives": [
{
"type": "image",
"url": "https://example.com/creative_00001.png"
},
{
"type": "image",
"url": "https://example.com/creative_00002.png"
},
{
"type": "html",
"url": "https:example.com/creative00002.zip"
}
],
"targeting": [
{
"action_on_clicks": "allow",
"condition": [
[
{
"field": "country",
"operator_type": "is_equal",
"value": "IN,US"
},
{
"field": "device_type",
"operator_type": "not_equal",
"value": "smartphone"
}
]
],
"rule_id": "101"
},
{
"action_on_clicks": "reject",
"condition": [
[
{
"field": "os",
"operator_type": "not_equal",
"value": "android"
}
]
],
"rule_id": "102"
},
{
"action_on_impressions": "allow",
"condition": [
[
{
"field": "country",
"operator_type": "is_equal",
"value": "IN,US"
},
{
"field": "os",
"operator_type": "is_equal",
"value": "windows"
}
]
],
"rule_id": "103"
}
]
}
}
}
Shared Capping - A single capping rule shared by multiple Affiliates.
The Suppression File URL will be valid for only 2 hours. We recommend downloading and using the file promptly to ensure uninterrupted access and functionality.
Query
Type
Description
offer_access
Integer
Allowed values 1: Approve Public Offers (&offer_access=1)
https://api.offer18.com/api/af/offers?key=000000000&aid=0000&mid=0000&offer_access=1