api-appglowing.affise.com
Open in
urlscan Pro
34.91.164.94
Public Scan
Submitted URL: https://api-appglowing.affise.com/
Effective URL: https://api-appglowing.affise.com/docs3.1/
Submission: On March 22 via api from US — Scanned from US
Effective URL: https://api-appglowing.affise.com/docs3.1/
Submission: On March 22 via api from US — Scanned from US
Form analysis 0 forms found in the DOM
Text Content
NAV
shell
* Introduction
* Authorization
* Statistics
* Custom statistics
* Conversion
* Conversions
* Clicks
* By date
* Hourly
* By sub
* By offer
* By advertiser
* By accounts managers
* By affiliates managers
* By affiliate
* By affiliate and date
* By country
* By browser
* By browser version
* By landing
* By prelanding
* By mobile carrier
* By connection type
* By OS
* By OS version
* By goal
* By city
* By device
* By device model
* By referral payments
* Find subs
* By server postback
* By partner postback
* By cap
* By trafficback
* Retention rate
* Time to action
* Affiliate methods
* Get partner own data
* Offer list
* Live offer list
* Activation offer
* List of promocodes
* Add postback
* Edit postback
* Delete postback
* Delete postbacks by offers ids
* News list
* News get by ID
* Pixel list
* Pixel add
* Pixel edit
* Pixel remove
* Affiliate balance
* SmartLink categories
* SmartLink offer count
* Get referrals
* Change partner api key
* Import single conversion
* Import multiple conversions
* Offers
* Offers list
* Offer by id
* Categories
* Advertiser managing (admin methods)
* Get advertiser
* Advertisers list
* Add advertiser
* Edit advertisers
* Send password to advertiser
* Advertisers enable affiliate
* Advertisers disable affiliate
* Advertiser billing managing (admin methods)
* Invoices list
* Invoices view
* Add invoice
* Edit invoice
* Offer managing (admin methods)
* Count of active offers
* Add offer
* Edit offer
* Delete offer
* Enabled/disabled affiliates list
* Sources
* Source add
* Source edit
* Source remove
* Category add
* Category edit
* Enable affiliate
* Disable affiliate
* Update offer`s status
* Disable affiliates
* Disable offers
* Remove creative from offer
* Change HTML creatives
* Delete HTML creatives
* List of promocodes
* Promocodes bulk creation
* Affiliate managing (admin methods)
* Get affiliate
* Affiliate list
* New affiliate
* Edit affiliate
* Mass update
* Change affiliate password
* Add partner postback
* Edit partner postback
* Delete partner postback
* Delete partners postbacks by affiliates ids
* Delete partners postbacks by offers ids
* Affiliate postbacks list
* Update partner locale
* Get referrals
* User managing (admin methods)
* Users list
* Add user
* Edit user
* Change user api key
* Change user password
* Update user permissions
* Read user
* Public auth
* Conversions managing
* Edit conversion
* Import single conversion
* Import multiple conversions
* Other managing (admin methods)
* City list
* Devices list
* Browsers list
* Currency list
* Payment systems list
* Custom fields list
* Domains list
* Get ticket
* Ticket list
* Approve or reject ticket for connect affiliate to offer
* Approve or reject ticket for connect affiliate to SmartLink
* Pixel list
* Pixel add
* Pixel edit
* Pixel remove
* SmartLink categories
* SmartLink category
* Smartlink edit category
* SmartLink category remove
* SmartLink offer count
* Presets (admin methods)
* Get list of presets
* Create preset
* Update preset
* Delete preset
* Automation (admin methods)
* Kpi automation list
* Create new kpi automation
* Edit kpi automation
* Remove kpi automation
* Kpi automation changes
* Kpi automation block log
* CR and SUB automation block log
* Other managing
* ISP list
* Countries list
* Regions list
* Cities list
* Connection types list
* Vendors list
* Oses list
* OS versions list
* Status Codes
* Billing API
* Get payments list
* Get payment invoice info
* Create payment invoice
* Generate payment invoices for affiliates
* Update payment invoice
* Add correction value for payment invoice
* Remove correction value for payment invoice
* Remove payment invoice
* Remove several payment invoices
INTRODUCTION
API 3.1 documentation.
AUTHORIZATION
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" http://YOUR_API_DOMAIN/
or
curl http://YOUR_API_DOMAIN/some_path?API-Key=23df424b0a53b0899f78685966243ee61
For data exchange using authentication public key passed as parameter in the
header API-Key. As the key, a hash generated for your site. API key, you can see
in your profile.
Find out more about where you can get your API URL, API-key and personal API-key
for Affiliate here - Getting Started with API
All API requests must include an API-Key header or API-Key GET parameter for
client authentication.
STATISTICS
CUSTOM STATISTICS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/custom?slice[]=year&slice[]=month&slice[]=day&filter[date_from]=2017-03-01&filter[date_to]=2017-03-01&conversionTypes[]=total&conversionTypes[]=confirmed
> Response example:
{
"status": 1,
"stats": [
{
"slice": {
"year": 2017,
"month": 3,
"day": 1
},
"traffic": {
"raw": "1607530",
"uniq": "1468939"
},
"actions": {
"total": {
"revenue": 1252,
"charge": 1352.52,
"earning": 100.52,
"null": 825,
"count": 1092
},
"confirmed": {
"revenue": 1252,
"charge": 1352.52,
"earning": 100.52,
"null": 728,
"count": 995
}
}
}
],
"pagination": {
"per_page": 100,
"total_count": 1,
"page": 1
}
}
Get custom statistics
GET /3.0/stats/custom
Parameter Type Available & Default Description slice Array[string] Available:
hour, month, quarter, year, day, offer, country, city, os, os_version, device,
device_model, browser, goal, sub1, sub2, sub3, sub4, sub5.
Only for admin: advertiser, affiliate, manager, smart_id.
Only for users with special permission: trafficback_reason REQUIRED Custom stats
slice filter[date_from] String Available: YYYY-MM-DD REQUIRED Date from
filter[date_to] String Available: YYYY-MM-DD REQUIRED Date to filter[currency]
Array[string] Default: All currencies code The list of a currencies code you can
get from API /3.0/admin/currency filter[advertiser] Mixed: String or
Array[string] Advertiser ID’s filter[offer] Array[integer] Offers ID’s
filter[manager] Mixed: String or Array[string] Managers ID’s
filter[advertiser_manager_id] Mixed: String or Array[string] Advertiser managers
ID’s filter[partner] Mixed: String or Array[string] Default: If the request from
not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub
number 1 filter[sub2] Mixed: String or Array[string] Sub number 2 filter[sub3]
Mixed: String or Array[string] Sub number 3 filter[sub4] Mixed: String or
Array[string] Sub number 4 filter[sub5] Mixed: String or Array[string] Sub
number 5 filter[device] Mixed: String or Array[string] Device filter[smart_id]
Mixed: String or Array[smart_id] Allowed only when the smart slice selected
SmartLink categories ID’s filter[nonzero] Integer Available: 1, 0 Non-zero
conversions filter[advertiser_tag] String Comma separated array of strings.
Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma separated array
of strings. Example: tag1,tag2,tag3 locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice conversionTypes Array[string] Available: total, confirmed, pending,
declined, hold Only this conversion types will be output page Integer Default: 1
Page of stat entities limit Integer Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order order Array[string] Available: hour, month,
quarter, year, day, currency, offer, country, city, os, os_version, device,
device_model, browser, goal, sub1, sub2, sub3, sub4, sub5, confirmed_earning,
raw, uniq, total_count, total_revenue, total_null, pending_count,
pending_revenue, declined_count, declined_revenue, hold_count, hold_revenue,
confirmed_count, confirmed_revenue.
Only for admin: advertiser, affiliate, manager Sort by field timezone string
Default: Timezone of your platform Timezone name. Example: “Europe/Berlin”
fields Array[string] Available: clicks, hosts, earnings, income, noincome,
payouts, conversions, cr, affiliate_epc, ratio, epc, trafficback. Available
extra fields if allow impressions: ctr, views,ecpm. Custom stats fields
CONVERSION
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/conversionsbyid?id={id}"
> Response example:
{
"conversion": {
"id": "5bd00d73901fcf20008b4574",
"action_id": "5bd00c641d580e000162cf94",
"status": 1,
"conversion_id": "5bd00d73901fcf20008b4574",
"cbid": "5bd00c641d580e000162cf94",
"currency": "USD",
"offer": {
"id": 7,
"title": "Test Offer",
"offer_id": "5b59b752f44d940011105103",
"url": "http://site.com"
},
"offer_id": 7,
"goal": "",
"hold_date_expire": null,
"ip": "172.18.0.1",
"country": "",
"country_name": "",
"district": null,
"city": "Undefined",
"city_id": 0,
"isp_code": "",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36",
"browser": "Unknown Unknown",
"os": "Linux Unknown",
"device": "desktop",
"device_type": "desktop",
"sub1": null,
"sub2": null,
"sub3": null,
"sub4": null,
"sub5": null,
"sub6": null,
"sub7": null,
"sub8": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"comment": null,
"created_at": "2018-10-22 09:13:07",
"click_time": "2018-10-22 09:08:36",
"updated_at": "2018-10-22 09:13:07",
"referrer": null,
"landing_id": null,
"prelanding_id": null,
"currency_id": null,
"price": null,
"clickid": "5bd00c641d580e000162cf94",
"partner": {
"id": 2,
"email": "emailtest@yahoo.com",
"login": "Yvette Michael",
"name": "Yvette Michael",
"manager": null
},
"supplier_id": "5b5f415035752723008b456a",
"partner_id": 2,
"goal_value": "1",
"sum": 0,
"revenue": 3,
"payouts": 3,
"earnings": 3,
"advertiser": {
"id": "5b5f415035752723008b456a",
"title": "Text supplier 2"
},
"payment_type": "fixed",
"payment_status": "opened",
"is_paid": "1",
"charge": 6,
"earning": 3,
"click_id": "5bd00c641d580e000162cf94",
"fraud_risk_level": "not_analyzed",
"decline_reason": "by_manager",
"fraud_type": [],
"createdAt": "2021-12-31 11:42:09",
"updatedAt": "2021-12-31 11:42:39"
},
"status": 1
}
Get conversions
GET /3.0/stats/conversionsbyid?id={id}
Available only for admin API-Key
CONVERSIONS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/conversions?action_id=&clickid=&country[0]=US¤cy=125&custom_field_1=&custom_field_2=&custom_field_3=&custom_field_4=&custom_field_5=&custom_field_6=&custom_field_7=&date_from=2017-05-01&date_to=2017-05-01&limit=1&page=1&payouts=&revenue=&timezone=Asia/Tokyo"
> Response example:
{
"status":1,
"conversions":[
{
"id":"59359e1d7e28feb7568b456a",
"action_id":"59359dcb7e28fee0558b4567",
"status":"confirmed",
"currency":"USD",
"goal":null,
"country":"US",
"district":"",
"city":"New York",
"ip":"127.0.0.1",
"browser":"Chrome 58.0.3029",
"os":"Mac OS X 10.12.5",
"device":"Other",
"offer":{ // Will return null if the offer doesn't exist
"id":934,
"offer_id":"59313e097960ad2774b4f274",
"title":"HD-smart [Web]",
"url":"http:\/\/YOUR_API_DOMAIN\/1\/"
},
"offer_id":"934",
"ios_idfa":"",
"android_id":"",
"sub1":"",
"sub2":"",
"sub3":"",
"sub4":"",
"sub5":"",
"custom_field_1":"",
"custom_field_2":"",
"custom_field_3":"",
"custom_field_4":"",
"custom_field_5":"",
"custom_field_6":"",
"custom_field_7":"",
"ua":"Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/58.0.3029.110 Safari\/537.36",
"comment":"",
"created_at":"2017-06-06 03:08:29",
"updated_at":"2017-06-06 03:08:30",
"click_time":"2017-06-06 03:07:07",
"referrer":"http://YOUR_API_DOMAIN",
"payouts":1234,
"clickid":"59359dcb7e28fee0558b4567",
"partner":{
"id":610,
"email":"example@gmail.com",
"login":"example",
"name":""
},
"goal_value":"1",
"sum":0,
"revenue":12345,
"earnings":11111,
"advertiser":{
"id":"56cc49dc3b7d9b89058b45f0",
"title":"Example"
},
"payment_status":"opened",
"is_paid":"1",
"forensiq":null,
"payment_type":null,
"hold_date_expire":null,
"fraud_risk_level": "not_analyzed",
"decline_reason": "by_manager",
"fraud_type": [],
}
],
"pagination":{
"per_page":1,
"total_count":17,
"page":1,
"next_page":2
}
}
Get conversions
GET /3.0/stats/conversions
Parameter Type Available & Default Description date_from String Available:
YYYY-MM-DD Default: day one week ago Date from date_to String Available:
YYYY-MM-DD Default: date now Date to update_from_date String Available:
YYYY-MM-DD Last update date point update_from_hour Between 0 and 23 Last update
hour point. Available only when update_from_date and update_to_date filters are
used update_to_date String Available: YYYY-MM-DD End date of last update
update_to_hour Between 0 and 23 End hour of last update. Available only when
update_from_date and update_to_date filters are used status Array[integer]
Available: 1, 2, 3, 5 Status conversions. 1 = confirmed, 2 = pending, 3 =
declined, 5 = hold offer Array[integer] Offer ID collection advertiser
Array[string] Advertiser ID collection country Array[string] Countries codes.
Example: “US” browser String Browser action_id String Cbid clickid String Click
ID os String Os goal String Goal device String Available: tablet, desktop,
mobile Device payouts Float Payout for affiliate payouts_from Float Payout for
affiliate must be greater than this value payouts_to Float Payout for affiliate
must be less than this value currency Integer ID currency hour Integer Between 0
and 23 Hour point
Allows only for one day period timezone String Default: Timezone of your
platform Timezone name. Example: “Europe/Berlin” custom_field_1 String Custom
field 1 custom_field_2 String Custom field 2 custom_field_3 String Custom field
3 custom_field_4 String Custom field 4 custom_field_5 String Custom field 5
custom_field_6 String Custom field 6 custom_field_7 String Custom field 7 subid1
String Sub 1 subid2 String Sub 2 subid3 String Sub 3 subid4 String Sub 4 subid5
String Sub 5 smart_id String Smartlink Id promocode String Promocode imp_id
String Impression Id payment_status String Available: opened, pending, closed
partner Array[integer] ONLY FOR ADMIN
Affiliates revenue Float ONLY FOR ADMIN Revenue revenue_from Float ONLY FOR
ADMIN Revenue must be greater than this value revenue_to Float ONLY FOR ADMIN
Revenue must be less than this value page integer Default: 1 Page of stat
entities limit integer Default: 100
Available: max 500 Limit of stat entities raw_export integer Default: 0 Without
mapping related entities (For huge exports) decline_reason Array[string] Filter
by decline reason. Available: anti_fraud, cap_reached, by_manager,
payment_not_found, ip_duplicate, by_server_postback, partner_banned,
partner_disabled, min_click_time_not_reached, click_time_expire, by_import,
promocode_expired, promocode_not_available fraud_risk_level Array[string] Filter
by fraud risk level. Available: not_analyzed, low, medium, high, no_risk
fraud_type Array[string] Filter by fraud type. comment String Comment
CLICKS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/clicks?date_from=2017-05-01&date_to=2017-07-31&limit=1
> Response example:
{
"status":1,
"clicks":[
{
"id":"59359dcb7e28fee0558b4567",
"ip":"127.0.0.1",
"ua":"Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/58.0.3029.110 Safari\/537.36",
"country":"US",
"city":"New York",
"device":"Other",
"os":"Mac OS X 10.12.5",
"browser":"Chrome 58.0.3029",
"referrer":"",
"sub1":"",
"sub2":"",
"sub3":"",
"sub4":"",
"sub5":"",
"offer":{
"id":934,
"offer_id":"59313e097960ad2774b4f274",
"title":"HD-smart [Web]"
},
"conversion_id":"59359e1d7e28feb7568b456a",
"ios_idfa":"",
"android_id":"",
"created_at":"2017-06-06 03:07:07",
"uniq":1,
"cbid":"59359dcb7e28fee0558b4567",
"partner_id":"610"
}
],
"pagination":{
"per_page":1,
"total_count":25,
"page":1
}
}
Get clicks
GET /3.0/stats/clicks
Available only for admin API-Key
Parameter Type Available & Default Description date_from String Available:
YYYY-MM-DD REQUIRED date_to String Available: YYYY-MM-DD REQUIRED hour Integer
Between 0 and 23 Hour point
Allows only for one day period offer Array[integer] Offer ID’s partner
Array[integer] Affiliates ID’s country Array[string] Countries codes. Example:
“US” advertisers Array[string] ONLY FOR ADMIN Advertiser ID collection timezone
String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” limit integer Default: 100
Available: max 500 Limit of stat entities
BY DATE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbydate?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"year":2017,
"month":5,
"day":31
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":8,
"page":1,
"next_page":2
}
}
Get statistics by date
GET /3.0/stats/getbydate
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
HOURLY
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyhour?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"year":2017,
"month":5,
"day":31,
"hour":0
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"confirmed":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
}
}
}
],
"pagination":{
"per_page":1,
"total_count":24,
"page":1,
"next_page":2
}
}
Get statistics by hour
GET /3.0/stats/getbyhour
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED filter[currency] Array[string] Default: All currencies code The list of
a currencies code you can get from API /3.0/admin/currency filter[advertiser]
Mixed: String or Array[string] Advertiser ID’s filter[offer] Array[integer]
Offers ID’s filter[manager] Mixed: String or Array[string] Managers ID’s
filter[advertiser_manager_id] Mixed: String or Array[string] Advertiser managers
ID’s filter[partner] Mixed: String or Array[string] Default: If the request from
not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY SUB
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbysub?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&filter[offer]=1&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"sub1":""
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by sub
GET /3.0/stats/getbysub
Available only for partner API-Key
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] REQUIRED Offers ID’s filter[manager] Mixed: String or
Array[string] Managers ID’s filter[advertiser_manager_id] Mixed: String or
Array[string] Advertiser managers ID’s filter[country] Mixed: String or
Array[string] Countries codes. Example: “US” filter[os] Mixed: String or
Array[string] Os filter[goal] Mixed: String or Array[string] Goal filter[sub1]
Mixed: String or Array[string] Sub 1 filter[sub2] Mixed: String or Array[string]
Sub 2 filter[sub3] Mixed: String or Array[string] Sub 3 filter[sub4] Mixed:
String or Array[string] Sub 4 filter[sub5] Mixed: String or Array[string] Sub 5
filter[sub6] Mixed: String or Array[string] Sub 6 filter[sub7] Mixed: String or
Array[string] Sub 7 filter[sub8] Mixed: String or Array[string] Sub 8
filter[device] Mixed: String or Array[string] Device filter[advertiser_tag]
String Comma separated array of strings. Example: tag1,tag2,tag3
filter[affiliate_tag] String Comma separated array of strings. Example:
tag1,tag2,tag3 filter[offer_tag] String Comma separated array of strings.
Example: tag1,tag2,tag3
BY OFFER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyprogram?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"offer":{
"id":906,
"offer_id":"59313e127960ad2774b4f2b9",
"title":"HD-smart [Web]"
}
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by offer
GET /3.0/stats/getbyprogram
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY ADVERTISER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyadvertiser?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"advertiser":{
"id":"56cc49dc3b7d9b89058b45f0",
"title":"advertiser"
}
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by advertiser
GET /3.0/stats/getbyadvertiser
Available only for admin API-Key
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Partners
ID’s. filter[country] Mixed: String or Array[string] Countries codes. Example:
“US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed: String or
Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY ACCOUNTS MANAGERS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyaccountmanager?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"advertiser_manager_id":{
"id":0,
"first_name":"Undefined",
"last_name":"Undefined"
}
},
"traffic":{
"raw":"9",
"uniq":"1"
},
"actions":{
"confirmed":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"declined":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"hold":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"pending":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"total":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
}
}
},
{
"slice":{
"advertiser_manager_id":{
"id":"57b1b91f47c449e70a8b4567",
"first_name":"tab",
"last_name":"GmbH"
}
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"confirmed":{
"charge":1.5874,
"earning":0.1587,
"null":3,
"revenue":1.4286,
"count":4
},
"declined":{
"charge":0,
"earning":0,
"null":2,
"revenue":0,
"count":2
},
"hold":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"pending":{
"charge":1.5874,
"earning":0.1587,
"null":0,
"revenue":1.4286,
"count":1
},
"total":{
"charge":3.1747,
"earning":0.3175,
"null":5,
"revenue":2.8572,
"count":7
}
}
}
],
"pagination":{
"per_page":100,
"total_count":2,
"page":1
}
}
Get statistics by accounts managers
GET /3.0/stats/getbyaccountmanager
Available only for admin API-Key
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Partners
ID’s. filter[country] Mixed: String or Array[string] Countries codes. Example:
“US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed: String or
Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY AFFILIATES MANAGERS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyaffiliatemanager?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"affiliate_manager_id":{
"id":"0",
"first_name":"Undefined",
"last_name":"Undefined"
}
},
"traffic":{
"raw":"9",
"uniq":"1"
},
"actions":{
"confirmed":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"declined":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"hold":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"pending":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"total":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
}
}
},
{
"slice":{
"affiliate_manager_id":{
"id":"57b1b91f47c449e70a8b4567",
"first_name":"tab",
"last_name":"GmbH"
}
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"confirmed":{
"charge":1.5874,
"earning":0.1587,
"null":3,
"revenue":1.4286,
"count":4
},
"declined":{
"charge":0,
"earning":0,
"null":2,
"revenue":0,
"count":2
},
"hold":{
"charge":0,
"earning":0,
"null":0,
"revenue":0,
"count":0
},
"pending":{
"charge":1.5874,
"earning":0.1587,
"null":0,
"revenue":1.4286,
"count":1
},
"total":{
"charge":3.1747,
"earning":0.3175,
"null":5,
"revenue":2.8572,
"count":7
}
}
}
],
"pagination":{
"per_page":100,
"total_count":2,
"page":1
}
}
Get statistics by affiliates managers
GET /3.0/stats/getbyaffiliatemanager
Available only for admin API-Key
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currencies
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Partners
ID’s. filter[country] Mixed: String or Array[string] Countries codes. Example:
“US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed: String or
Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY AFFILIATE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbypartner?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"affiliate":{
"id":610,
"email":"aff@iliate.com",
"login":"affiliate",
"name":""
}
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by affiliate
GET /3.0/stats/getbypartner
Available only for admin API-Key
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Partners
ID’s. filter[country] Mixed: String or Array[string] Countries codes. Example:
“US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed: String or
Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY AFFILIATE AND DATE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbypartnerbydate?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"year":2017,
"month":5,
"day":31,
"affiliate":{
"id":610,
"email":"affiliate@affiliate.com",
"login":"affiliate",
"name":""
}
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by affiliate and date
GET /3.0/stats/getbypartnerbydate
Available only for admin API-Key
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Partners
ID’s. filter[country] Mixed: String or Array[string] Countries codes. Example:
“US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed: String or
Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY COUNTRY
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbycountries?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"country":"USA"
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by country
GET /3.0/stats/getbycountries
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY BROWSER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbybrowsers?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"browser":""
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by browser
GET /3.0/stats/getbybrowsers
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY BROWSER VERSION
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbybrowsersversion?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"browser_version":"70"
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by browser version
GET /3.0/stats/getbybrowsersversion
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY LANDING
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbylanding?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&filter[offer]=1&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"landing":"1543238303"
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
},
"ratio": "",
"epc": 0,
"landings_info": {
"1543238303": {
"url": "http://test-url.com",
"preview_url": "http://test-preview-url.com",
"title": "333"
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by landing
GET /3.0/stats/getbylanding
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY PRELANDING
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyprelanding?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&filter[offer]=1&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"prelanding": 1543243821
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
},
"ratio": "",
"epc": 0,
"landings_info": {
"1543243821": {
"url": "http://test-url.com",
"preview_url": "http://test-preview-url.com",
"title": "333"
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by prelanding
GET /3.0/stats/getbyprelanding
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY MOBILE CARRIER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbymobilecarrier?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"isp": ""
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
},
"ratio": "",
"epc": 0
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by mobile carrier
GET /3.0/stats/getbymobilecarrier
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY CONNECTION TYPE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyconnectiontype?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"conn_type": ""
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
},
"ratio": "",
"epc": 0
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by connection type
GET /3.0/stats/getbyconnectiontype
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY OS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyos?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"os":""
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by OS
GET /3.0/stats/getbyos
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY OS VERSION
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbyversions?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"os":"",
"os_version":""
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by os version
GET /3.0/stats/getbyversions
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY GOAL
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbygoal?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"goal":"1"
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by goal
GET /3.0/stats/getbygoal
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY CITY
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbycities?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"city":0
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by city
GET /3.0/stats/getbycities
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY DEVICE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbydevices?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"device":""
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by device
GET /3.0/stats/getbydevices
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY DEVICE MODEL
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getbydevicemodels?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&locale=en&limit=1
> Response example:
{
"status":1,
"stats":[
{
"slice":{
"device_model":""
},
"traffic":{
"raw":"0",
"uniq":"0"
},
"actions":{
"total":{
"revenue":191190.40796039,
"charge":339894.05859619,
"earning":148703.65063587,
"null":0,
"count":12600
},
"confirmed":{
"revenue":15.173841901617,
"charge":26.975718936208,
"earning":11.801877034591,
"null":0,
"count":1
},
"pending":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"declined":{
"revenue":0,
"charge":0,
"earning":0,
"null":0,
"count":0
},
"hold":{
"revenue":191175.23411849,
"charge":339867.08287725,
"earning":148691.84875883,
"null":0,
"count":12599
}
}
}
],
"pagination":{
"per_page":1,
"total_count":1,
"page":1
}
}
Get statistics by device model
GET /3.0/stats/getbydevicemodels
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[currency] Array[string] Default: All currencies code The
list of a currencies code you can get from API /3.0/admin/currency
filter[advertiser] Mixed: String or Array[string] Advertiser ID’s filter[offer]
Array[integer] Offers ID’s filter[manager] Mixed: String or Array[string]
Managers ID’s filter[advertiser_manager_id] Mixed: String or Array[string]
Advertiser managers ID’s filter[partner] Mixed: String or Array[string] Default:
If the request from not an admin then default a ID partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[os] Mixed: String or Array[string] Os filter[goal] Mixed:
String or Array[string] Goal filter[sub1] Mixed: String or Array[string] Sub 1
filter[sub2] Mixed: String or Array[string] Sub 2 filter[sub3] Mixed: String or
Array[string] Sub 3 filter[sub4] Mixed: String or Array[string] Sub 4
filter[sub5] Mixed: String or Array[string] Sub 5 filter[sub6] Mixed: String or
Array[string] Sub 6 filter[sub7] Mixed: String or Array[string] Sub 7
filter[sub8] Mixed: String or Array[string] Sub 8 filter[device] Mixed: String
or Array[string] Device filter[advertiser_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated
array of strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma
separated array of strings. Example: tag1,tag2,tag3
BY REFERRAL PAYMENTS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/getreferralpayments?filter[date_from]=2017-05-31&filter[date_to]=2017-05-31&orderType=asc&limit=1
> Response example:
{
"status":1,
"ref_payments":[
{
"pid":"2",
"ref":"3",
"status":"0",
"is_paid":"0",
"currency":"USD",
"count":"4",
"max_created_at":"2016-03-19 16:25:22",
"date_registration_partner":"2016-10-30 10:22:12",
"sum_revenue":"0.20000"
}
],
"pagination":{
"per_page":100,
"total_count":1,
"page":1
}
}
Get statistics by referral payments
GET /3.0/stats/getreferralpayments
Parameter Type Available & Default Description date_from String Available:
DD-MM-YYYY REQUIRED Date from date_to String Available: DD-MM-YYYY REQUIRED Date
to timezone string Timezone name. Example: “Europe/Berlin” pid Integer Partner
ID pids Array[integer] List of partner IDs ref Integer Referral partner ID refs
Array[integer] List of referral partner IDs is_paid Integer Available: 0 =>
payouts, 1 => paid, 2 => pending Status payment_statuses Array[integer] List of
“is_paid” values status Integer Available: 0 => no, 1 => yes Active page Integer
Default: 1 Page of stat entities limit Integer Default: 100
Available: max 500 Limit of stat entities currency Integer ID currency
currencies Array[integer] List of currency IDs
FIND SUBS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/find-subs?sub1=1
> Response example:
{
"status":1,
"subs":[
{
"sub1":"test1"
}
],
"pagination":{
"per_page":100,
"total_count":0,
"page":1
}
}
Get sub accounts
GET /3.0/stats/find-subs
Available only for partner API-Key
Parameter Type Available & Default Description sub1 String Sub 1 sub2 String Sub
2 sub3 String Sub 3 sub4 String Sub 4 sub5 String Sub 5 page integer Default: 1
Page of sub entities limit integer Default: 100
Available: max 500 Limit of sub entities
BY SERVER POSTBACK
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/stats/serverpostbacks?date_from=01-04-2017&date_to=01-07-2017&offer[0]=59313e087960ad2774b4f269&partner[0]=610&search=610&click_id=59359dcb7e28fee0558b4567&goal=1
> Response example:
{
"status":1,
"postbacks":[
{
"_id":{
"$id":"59359e1d7e28feb7568b4569"
},
"_get":{
"clickid":"59359dcb7e28fee0558b4567"
},
"_post":[
],
"date":{
"sec":1496686109,
"usec":35000
},
"get":"{\u0022clickid\u0022:\u002259359dcb7e28fee0558b4567\u0022}",
"post":"[]",
"server":"127.0.0.1",
"response":"{\n \u0022status\u0022: 1\n}",
"track":{
"id":"59359dcb7e28fee0558b4567",
"ip":"127.0.0.1",
"ua":"Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/58.0.3029.110 Safari\/537.36",
"country":"US",
"city":"New York",
"device":"Other",
"os":"Mac OS X 10.12.5",
"browser":"Chrome 58.0.3029",
"offer":{
"id":934,
"offer_id":"59313e097960ad2774b4f274",
"title":"HD-smart [Web]",
"preview_url":"http:\/\/YOUR_API_DOMAIN\/desktop\/1\/"
},
"referrer":"",
"click_id":"59359dcb7e28fee0558b4567",
"sub1":"",
"sub2":"",
"sub3":"",
"sub4":"",
"sub5":"",
"offer_id":"934",
"conversion_id":null,
"ios_idfa":null,
"android_id":null,
"created_at":"2017-06-06 03:07:07",
"uniq":1,
"cbid":null,
"partner":{
"id":"610",
"login":"affiliate",
"email":"affi@lia.te"
}
}
}
],
"pagination":{
"per_page":100,
"total_count":1,
"page":1
}
}
Get server postbacks
GET /3.0/stats/serverpostbacks
Available only for admin API-Key
Parameter Type Available & Default Description date_from String Available:
YYYY-MM-DD REQUIRED date_to String Available: YYYY-MM-DD REQUIRED offer_id
Array[integer] Offers ID’s partner Array[integer] Partners ID’s. supplier
Array[string] Advertiser ID’s. action_id String Action id click_id String Click
id goal String Goal is_success String Available: 0,1 Status timezone string
Default: Timezone of your platform Timezone name. Example: “Europe/Berlin” page
integer Default: 1 Page of stat entities limit integer Default: 100
Available: max 500 Limit of stat entities
BY PARTNER POSTBACK
curl -X GET \
'http://<YOUR_DOMAIN>/3.0/stats/affiliatepostbacks?date_from=2017-11-25&date_to=2017-11-28&partner%5B%5D=2&goal=1&http_code=200' \
-H 'api-key: 69cebe280a74bb8863a6d2b37df1f72b910e6a7c' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
> Response example:
{
"status": 1,
"postbacks": [
{
"_id": {
"$id": "5a1d248f1bfa2441008b4567"
},
"_get": null,
"_post": null,
"date": {
"sec": 1511859343,
"usec": 662000
},
"pid": 2,
"lead_id": "5a1d247cbbf68e0001972d26",
"http_code": 200,
"postback_url": "http://dsda.com",
"offer_id": 1,
"job_id": "5a1d248a1bfa2418008b456b",
"goal": "1",
"status": 1
}
],
"pagination": {
"per_page": 100,
"total_count": 1,
"page": 1
}
}
Get partner postbacks
GET /3.0/stats/affiliatepostbacks
Available only for admin API-Key
Parameter Type Available & Default Description date_from String Available:
YYYY-MM-DD REQUIRED date_to String Available: YYYY-MM-DD REQUIRED offer
Array[integer] Offers ID’s partner Array[integer] Partners ID’s. goal String
Goal status integer Status http_code integer Http code timezone string Default:
Timezone of your platform Timezone name. Example: “Europe/Berlin” page integer
Default: 1 Page of stat entities limit integer Default: 100
Available: max 500 Limit of stat entities
BY CAP
curl -X GET \
'http://<YOUR_DOMAIN>/3.1/stats/caps?offer_id[]=10' \
-H 'api-key: 69cebe280a74bb8863a6d2b37df1f72b910e6a7c' \
> Response example:
{
"status": 1,
"stats": [
{
"offer_id": 10,
"stats": [
{
"affiliate_type": "string",
"affiliates": [],
"countries": [
"string"
],
"country_type": "string",
"current_value": 0,
"goal_stats": {
},
"goal_type": "string",
"goals": [],
"id": "string",
"is_remaining": true,
"reset_to_value": 0,
"timeframe": "string",
"type": "string",
"value": 0
}
]
}
]
}
Get stats by cap
GET /3.1/stats/caps
Parameter Type Available & Default Description offer_id Array[integer] REQUIRED
Offers ID’s
BY TRAFFICBACK
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN}/3.0/stats/getbytrafficback?filter[date_from]=2019-12-09&filter[date_to]=2019-12-12
> Response example:
{
"status": 1,
"stats": [
{
"slice": {
"trafficback_reason": "unknown-affiliate"
},
"traffic": {
"raw": "0",
"uniq": "0"
},
"actions": [],
"views": 0,
"ctr": 0,
"trafficback": 1
},
{
"slice": {
"trafficback_reason": "invalid-affiliate"
},
"traffic": {
"raw": "0",
"uniq": "0"
},
"actions": [],
"views": 0,
"ctr": 0,
"trafficback": 47
}
],
"pagination": {
"per_page": 100,
"total_count": 2,
"page": 1
}
}
Get statistics by trafficback
GET /3.0/stats/getbytrafficback
Parameter Type Available & Default Description locale String Default: en
Available: ru, en, es Locale for output a cities data when you use the city
slice timezone String Default: Timezone of your platform Timezone name. Example:
“Europe/Berlin” page integer Default: 1 Page of stat entities limit integer
Default: 100
Available: max 500 Limit of stat entities orderType String Default: asc
Available: asc, desc Sorting order filter[date_from] String Available:
YYYY-MM-DD REQUIRED Date from filter[date_to] String Available: YYYY-MM-DD
REQUIRED Date to filter[advertiser] Mixed: String or Array[string] Advertiser
ID’s filter[offer] Array[integer] Offers ID’s filter[partner] Mixed: String or
Array[string] Default: If the request from not an admin then default a ID
partner ONLY FOR ADMIN
Partners ID’s. filter[country] Mixed: String or Array[string] Countries codes.
Example: “US” filter[advertiser_tag] String Comma separated array of strings.
Example: tag1,tag2,tag3 filter[affiliate_tag] String Comma separated array of
strings. Example: tag1,tag2,tag3 filter[offer_tag] String Comma separated array
of strings. Example: tag1,tag2,tag3
RETENTION RATE
curl -X GET \
'http://<YOUR_DOMAIN>/3.0/stats/retentionrate?date_from=2018-10-16&date_to=2018-10-19&offer_id=28&base_event=install
&events=install,other1,other2&timezone=Europe/Moscow&affiliate_id=1' \
-H 'api-key: 69cebe280a74bb8863a6d2b37df1f72b910e6a7c' \
> Response example:
[
{
"affiliate_id": 1,
"date": "2018-10-18",
"rr_install": 66.66,
"rr_other1": 100,
"rr_other2": 33.33,
"install_count": 3
},
{
"affiliate_id": 1,
"date": "2018-10-19",
"rr_install": 0,
"rr_other1": 100,
"rr_other2": 0,
"install_count": 1
}
]
Get stats retentionrate
GET /3.0/stats/retentionrate
Parameter Type Available & Default Description date_from String Available:
YYYY-MM-DD REQUIRED Date from date_to String Available: YYYY-MM-DD REQUIRED Date
to offer Integer REQUIRED base_event string Available: ^[a-zA-Z] REQUIRED Name
based goal events Array[string] Available: ^[a-zA-Z] REQUIRED events
affiliate_id integer Affiliates filter timezone string Default: Timezone of your
platform Timezone name. Example: “Europe/Berlin”
Fields description:
* goal - contains name based goal
* events - event list comma separated
TIME TO ACTION
curl -X GET \
'http://<YOUR_DOMAIN>/3.0/stats/time-to-action?timezone=Europe/Moscow&affiliate_ids=70,71&date_from=2019-11-16&date_to=2019-11-18&offer_id=7' \
-H 'api-key: 69cebe280a74bb8863a6d2b37df1f72b910e6a7c' \
> Response example:
{
"data": [
{
"affiliate_id": 70,
"affiliate_name": "Yve",
"affiliate_email": "affi@lia.te",
"clicks": 90,
"total_conversions": 4,
"tta_30": 3,
"tta_600": 1,
"tta_inf": 0
}
],
"status": 1,
"pagination": {
"total_count": 1,
"per_page": 100,
"page": 1
},
"statusCode": 200
}
Get Time to action report
GET /3.0/stats/time-to-action
Parameter Type Available & Default Description date_from String Available:
YYYY-MM-DD REQUIRED Date from date_to String Available: YYYY-MM-DD REQUIRED Date
to offer_id Integer REQUIRED An offer id timezone string REQUIRED Timezone
Timezone name. Example: “Europe/Berlin” goal string Name based goal
affiliate_ids integer Affiliates filter. Comma separated int values page Integer
Default: 1 Page of stat entities limit Integer Default: 100
Available: max 500 Limit of stat entities
AFFILIATE METHODS
GET PARTNER OWN DATA
curl -X GET \
'http://YOUR_API_DOMAIN/3.1/partner/me' \
-H 'api-key: {API-KEY}'
> Response example:
{
"status": 1,
"user": {
"partner_id": 2,
"needAcceptTerms": false,
"manager": {
"name": "firstName lastName",
"email": "manager@manager.com",
"skype": "manager",
"work_hours": "24"
},
"id": "5d91e81acbe5a8fd53e7215d",
"api_key": "cd21e0d96fdfcd181403531854bba48f",
"info": null,
"created_at": "2019-09-30T11:33:46Z",
"settings": null,
"email": "test1.users-stage-v1@cud.partner",
"login": "test11.users-stage-v1@cud.partner",
"name": null,
"company": null,
"status": "1",
"updated_at": "2019-10-02T07:28:01Z",
"confirm_code": null,
"ref": null,
"lang": "en",
"timezone": null,
"level": null,
"manager_id": "",
"notes": "",
"ref_percent": null,
"pay_sys": null,
"pay_acc": "",
"pay_acc_wmz": "",
"balance_ru": "0.00",
"hold_ru": "0.00",
"available_ru": "0.00",
"balance_usd": "0.00",
"hold_usd": "0.00",
"available_usd": "0.00",
"address_1": null,
"address_2": null,
"city": null,
"country": "GH",
"zip_code": null,
"phone": null,
"sub_accounts": {
"1": {
"value": "",
"except": 0
},
"2": {
"value": "",
"except": 0
}
},
"type": "affiliate",
"permissions": {
"automation": {
"affise-checker": {
"level": "deny"
}
},
"general": {
"marketplace": {
"level": "read"
},
"settings": {
"level": "deny"
}
},
"notificator": {
"client-subscription": {
"level": "write"
},
"transport-configuration": {
"level": "write"
},
"user-subscription": {
"level": "write"
}
},
"stats": {
"affiliate-postback": {
"level": "read"
},
"clicks-list": {
"level": "read"
},
"comparison-report": {
"level": "read"
},
"conversions-export": {
"level": "read"
},
"conversions-import": {
"level": "write"
},
"conversions-list": {
"level": "read"
},
"entity-account-manager": {
"level": "read",
"default_level": "read",
"exceptions": {
"strings": []
}
},
"entity-affiliate-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"referral": {
"level": "deny"
},
"server-postback": {
"level": "read"
},
"slice-account_manager_id": {
"level": "deny"
},
"slice-advertiser_id": {
"level": "deny"
},
"slice-affiliate_id": {
"level": "read"
},
"slice-affiliate_manager_id": {
"level": "deny"
},
"slice-browser": {
"level": "deny"
},
"slice-city": {
"level": "read"
},
"slice-connection-type": {
"level": "deny"
},
"slice-country": {
"level": "read"
},
"slice-day": {
"level": "read"
},
"slice-device": {
"level": "read"
},
"slice-goal": {
"level": "read"
},
"slice-landing": {
"level": "deny"
},
"slice-mobile-carrier": {
"level": "deny"
},
"slice-offer_id": {
"level": "read"
},
"slice-os": {
"level": "read"
},
"slice-prelanding": {
"level": "deny"
},
"slice-smart_id": {
"level": "deny"
},
"slice-sub1": {
"level": "deny"
},
"slice-sub2": {
"level": "deny"
},
"slice-trafficback_reason": {
"level": "read"
},
"stats-export": {
"level": "read"
},
"view-custom": {
"level": "read"
},
"view-kpi": {
"level": "deny"
},
"view-retention-rate": {
"level": "deny"
}
},
"users": {
"entity-account-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-advertiser": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-affiliate": {
"level": "deny",
"exceptions": {
"ints": []
}
},
"entity-affiliate-manager": {
"level": "write",
"exceptions": {
"strings": []
}
},
"entity-common-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-preset": {
"level": "deny"
},
"view-users": {
"level": "deny"
}
}
},
"work_hours": "",
"last_login_at": "2019-10-02T07:29:22Z"
}
}
Get partner own data
GET /3.1/partner/me
OFFER LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/partner/offers
> Response example:
{
"status":1,
"offers":[
{
"id":902,
"offer_id":"5718dac83b7d9bf8588b4579",
"bundle_id": "46cc97dc3b7d9b10758b45f0",
"title":"...",
"preview_url":"....",
"description_lang": {
"cn": "",
"en": "",
"es": "",
"ka": "",
"my": "",
"pt": "",
"ru": "",
"vi": ""
},
"cr":199850,
"epc":298988.33,
"logo":"http:\/\/YOUR_API_DOMAIN\/images\/cpa\/logos\/2602108452.png",
"logo_source":"...",
"stop_at":"",
"sources":[
{
"id":"51f531f53b7d9b1e0382f6d9",
"title":"Web sites",
"allowed":1
}
],
"categories":[
"..."
],
"full_categories":[
{
"id":"5368afb23b7d9b4d5d505342",
"title":"..."
}
],
"payments":[
{
"countries":[
"US"
],
"cities": [],
"devices": [],
"os": [],
"goal": "1",
"revenue": 0,
"currency": "usd",
"title": "",
"type": "fixed",
"country_exclude": true
}
],
"caps": [
{
"goals": {},
"period": "day",
"type": "conversions",
"value": 10,
"goal_type": "all",
"country_type": "all",
"country": []
}
],
"caps_status": [],
"required_approval":true,
"is_cpi":false,
"creatives":[
],
"creatives_zip":null,
"impressions_link": null,
"landings": [],
"links":[
{
"id":null,
"title":null,
"hash":null,
"url":"http:\/\/YOUR_API_DOMAIN\/click?pid=610\u0026offer_id=902",
"postbacks":[
],
"created":null
}
],
"macro_url":null,
"link":"http:\/\/YOUR_API_DOMAIN\/click?pid=610\u0026offer_id=902",
"use_https":false,
"use_http":true,
"hold_period":0,
"kpi": {
"en": ""
},
"click_session": "1y",
"minimal_click_session": "0s",
"targeting": [
{
"country": {
"allow": [],
"deny": []
},
"region": {
"allow": [],
"deny": []
},
"city": {
"allow": [],
"deny": []
},
"os": {
"allow": [],
"deny": []
},
"isp": {
"allow": [],
"deny": []
},
"ip": {
"allow": [],
"deny": []
},
"browser": {
"allow": [],
"deny": []
},
"brand": {
"allow": [],
"deny": []
},
"device_type": [],
"connection": [],
"id": "991f9eb4-0f12-4e6a-805a-1ed7aab01ef4",
"block_proxy": false
}
],
"commission_tiers": [
{
"id": "e09f260e-8461-4b7d-aa30-3c164a70c1bc",
"goals": [],
"timeframe": "all",
"type": "conversions",
"value": 1,
"target_goals": [],
"modifier_type": "by_fix",
"modifier_value": 0.0002,
"countries": [],
"conversion_status": [
"confirmed",
"declined",
"pending",
"hold"
],
"modifier_payment_type": "payout"
}
],
"enabled_commission_tiers": true,
"consider_personal_targeting_only": false,
"hosts_only": false,
"uniq_ip_only": false,
"reject_not_uniq_ip": 0
}
],
"pagination":{
"per_page":1,
"total_count":127,
"page":1,
"next_page":2
}
}
Get list of available partner offers
GET /3.0/partner/offers
Parameter Type Available & Default Description q String Search by title and id
int_id Array[integer] Search by int offer ID countries Array[string] Array of
offers countries(ISO) categories Array[string] Array of offers categories
caps_country String Comma separated array of strings. Example: US,DE. If one or
more cap filters are set (caps_country, caps_type), other filters are ignored
caps_type String Comma separated array of strings. Example:
clicks,conversions,budget,impressions. If one or more cap filters are set
(caps_country, caps_type), other filters are ignored. This filter will not show
offers for the selected cap type if the cap is full sort Array[string] Sort
offers. Sample sort[id]=asc, sort[title]=desc. You can sort offers by one of
(id, title, cr, epc) page Integer Page of offers limit Integer Default: 100
Available: max 500 Count offers by page
LIVE OFFER LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/partner/live-offers
> Response example:
{
"status":1,
"offers":[
{
"id":902,
"offer_id":"5718dac83b7d9bf8588b4579",
"bundle_id": "46cc97dc3b7d9b10758b45f0",
"title":"...",
"preview_url":"....",
"description_lang": {
"cn": "",
"en": "",
"es": "",
"ka": "",
"my": "",
"pt": "",
"ru": "",
"vi": ""
},
"cr":199850,
"epc":298988.33,
"logo":"http:\/\/YOUR_API_DOMAIN\/images\/cpa\/logos\/2602108452.png",
"logo_source":"...",
"stop_at":"",
"sources":[
{
"id":"51f531f53b7d9b1e0382f6d9",
"title":"Web sites",
"allowed":1
},
{
"id":"51f532103b7d9b340e325f1c",
"title":"Context AD",
"allowed":1
},
{
"id":"51f532393b7d9b5e030908a0",
"title":"Teaser\/banner AD",
"allowed":1
},
{
"id":"51f532713b7d9b5e03b24520",
"title":"Social networks: publics, games, applications",
"allowed":1
},
{
"id":"51f532873b7d9b5e03e88a74",
"title":"Emailing",
"allowed":1
}
],
"categories":[
"..."
],
"full_categories":[
{
"id":"5368afb23b7d9b4d5d505342",
"title":"..."
}
],
"payments":[
{
"countries":[
"US"
],
"cities": [],
"devices": [],
"os": [],
"goal": "1",
"revenue": 0,
"currency": "usd",
"title": "",
"type": "fixed",
"country_exclude": true
}
],
"caps": [
{
"goals": {},
"period": "day",
"type": "conversions",
"value": 10,
"goal_type": "all",
"country_type": "all",
"country": []
}
],
"required_approval":true,
"is_cpi":false,
"creatives":[
],
"creatives_zip":null,
"impressions_link": null,
"landings": [],
"links":[
{
"id":null,
"title":null,
"hash":null,
"url":"http:\/\/YOUR_API_DOMAIN\/click?pid=610\u0026offer_id=902",
"postbacks":[
],
"created":null
}
],
"macro_url":null,
"link":"http:\/\/YOUR_API_DOMAIN\/click?pid=610\u0026offer_id=902",
"use_https":false,
"use_http":true,
"hold_period":0,
"kpi": {
"en": ""
},
"click_session": "1y",
"minimal_click_session": "0s",
"targeting": [
{
"country": {
"allow": [],
"deny": []
},
"region": {
"allow": [],
"deny": []
},
"city": {
"allow": [],
"deny": []
},
"os": {
"allow": [],
"deny": []
},
"isp": {
"allow": [],
"deny": []
},
"ip": {
"allow": [],
"deny": []
},
"browser": {
"allow": [],
"deny": []
},
"brand": {
"allow": [],
"deny": []
},
"device_type": [],
"connection": [],
"id": "991f9eb4-0f12-4e6a-805a-1ed7aab01ef4",
"block_proxy": false
}
],
"commission_tiers": [
{
"id": "e09f260e-8461-4b7d-aa30-3c164a70c1bc",
"goals": [],
"timeframe": "all",
"type": "conversions",
"value": 1,
"target_goals": [],
"modifier_type": "by_fix",
"modifier_value": 0.0002,
"countries": [],
"conversion_status": [
"confirmed",
"declined",
"pending",
"hold"
],
"modifier_payment_type": "payout"
}
],
"enabled_commission_tiers": true,
"consider_personal_targeting_only": false,
"hosts_only": false,
"uniq_ip_only": false,
"reject_not_uniq_ip": 0
}
],
"pagination":{
"per_page":1,
"total_count":127,
"page":1,
"next_page":2
}
}
Get list of a live offers
GET /3.0/partner/live-offers
Parameter Type Available & Default Description q String Search by title and id
int_id Array[integer] Search by int offer ID countries Array[string] Array of
offers countries(ISO) categories Array[string] Array of offers categories
caps_country String Comma separated array of strings. Example: US,DE. If one or
more cap filters are set (caps_country, caps_type), other filters are ignored
caps_type String Comma separated array of strings. Example:
clicks,conversions,budget,impressions. If one or more cap filters are set
(caps_country, caps_type), other filters are ignored sort Array[string] Sort
offers. Sample sort[id]=asc, sort[title]=desc. You can sort offers by one of
(id, title, cr, epc) page Integer Page of offers limit Integer Default: 100
Available: max 500 Count offers by page
ACTIVATION OFFER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "offer_id=123&comment=test" http://YOUR_API_DOMAIN/3.0/partner/activation/offer
> Response example:
{
"status":1,
"message":"Request is successfully"
}
Connect to an offer
POST /3.0/partner/activation/offer
Parameter Type Available & Default Description offer_id Integer REQUIRED comment
String REQUIRED
LIST OF PROMOCODES
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "url=http://YOUR_API_DOMAIN&offer_id=906" http://YOUR_API_DOMAIN/3.1/offers/promocodes
> Response example:
{
"status": 1,
"data": {
"promocodes": [
{
"id": "63bbf54e8098683662ea61b5",
"type": "manual",
"code": "Black-1",
"code_template": "",
"description": "Some description",
"offer_id": 13,
"affiliate_id": 4,
"usage_limit": 100,
"usage_value": 0,
"date_from": "2023-01-09T00:00:00Z",
"date_to": "2023-01-29T00:00:00Z",
"created_at": "2023-01-09T11:06:54.189Z",
"updated_at": "2023-01-09T11:06:54.189Z"
}
],
"total_count": 2,
"per_page": 100,
"page": 1
}
}
List of promocodes
GET 3.1/offers/promocodes
Parameter Type Available & Default Description offer_id Integer Comma separated
list of identifiers search String Search promocodes by part of string code
String Search promocode by exact match page Integer Default: 1 limit Integer
Default: 100
ADD POSTBACK
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "url=http://YOUR_API_DOMAIN&status=by_creating&offer_id=906" http://YOUR_API_DOMAIN/3.0/partner/postback
> Response example:
{
"status":1,
"postback":{
"id":960,
"url":"http:\/\/YOUR_API_DOMAIN",
"status":"by_creating",
"goal":null,
"created":"2017-06-20 02:17:58",
"updated_at":"2017-06-20 02:17:58",
"forced":"0",
"pid":"1"
}
}
Add postback
POST /3.0/partner/postback
Parameter Type Available & Default Description pid Integer REQUIRED offer_id
Integer Offer ID (missed parameter means creation of global postback) url String
REQUIRED Example: http://YOUR_API_DOMAIN status String Available: by_creating,
confirmed, pending, declined, hold Postback status. Status “not_found” is
deprecated and will be transformed to “declined”. goal String Postback goal
(value)
EDIT POSTBACK
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "url=http://YOUR_API_DOMAIN&status=confirmed&offer_id=906" http://YOUR_API_DOMAIN/3.0/partner/postback/960
> Response example:
{
"status":1,
"postback":{
"id":960,
"url":"http:\/\/YOUR_API_DOMAIN",
"status":"confirmed",
"goal":null,
"created":"2017-06-20 02:17:58",
"updated_at":"2017-06-20 02:17:58",
"forced":"0",
"pid":"1"
}
}
Edit postback
POST /3.0/partner/postback/{ID}
Parameter Type Available & Default Description url String REQUIRED Example:
http://YOUR_API_DOMAIN status String Available: by_creating, confirmed, pending,
declined, hold Postback status. Status “not_found” is deprecated and will be
transformed to “declined”. goal String Postback goal (value)
DELETE POSTBACK
curl -X DELETE --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/partner/postback/960/remove
> Response example:
{
"status":1,
"postback":{
"id":960,
"url":"http:\/\/YOUR_API_DOMAIN",
"offer_id":"4",
"status":"confirmed",
"goal":null,
"created":"2017-06-20 02:17:58",
"updated_at":"2017-06-20 02:17:58",
"forced":"0",
"pid":"1"
}
}
Delete postback
DELETE /3.0/partner/postback/{ID}/remove
DELETE POSTBACKS BY OFFERS IDS
curl -X DELETE --header "API-Key:{YOUR_API_KEY}" /
http://{YOUR_API_DOMAIN}/3.0/partner/postbacks/by-offers?ids=1,2,3
DELETE /3.0/partner/postbacks/by-offers
Parameter Type Available & Default Description ids comma separated array of
integers
NEWS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/news
> Response example:
{
"status":1,
"items":[
{
"_id":{
"$id":"57a4914f3b7d9bbd358b45b6"
},
"title":"Title news",
"small_desc":"....",
"desc":"....",
"status":1,
"created_at":{
"sec":1470402895,
"usec":891000
}
}
],
"all_items":334
}
News list
GET /3.0/news
Parameter Type Available & Default Description limit Integer Available: max 100
Default: 10 skip Integer Default: 0 Offset fixed Integer Available: 1, 0 1 -
pinned, 0 - not pinned
NEWS GET BY ID
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/news/57a4914f3b7d9bbd358b45b6
> Response example:
{
"status":1,
"news":{
"_id":{
"$id":"57a4914f3b7d9bbd358b45b6"
},
"title":"...",
"small_desc":"....",
"desc":"....",
"status":1,
"created_at":{
"sec":1470402895,
"usec":891000
}
}
}
Get news by ID
GET /3.0/news/{ID}
PIXEL LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/partner/pixels
> Response example:
{
"status":1,
"pixel":{
"1":{
"id":1,
"name":"...",
"code":"\u003Cscript\u003Ealert(\u0027123\u0027);\u003C\/script\u003E",
"code_type":"javascript",
"offer_id":"906",
"pid":"610",
"is_active":"0",
"moderation_status":"0",
"created_at":"2017-06-19 22:49:07",
"updated_at":"2017-06-19 22:49:07"
}
}
}
Get list of a partner’s pixels
GET /3.0/partner/pixels
PIXEL ADD
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "pid=610&offer_id=906&name=test&code=<script>test</script>&code_type=javascript" http://YOUR_API_DOMAIN/3.0/partner/pixel
> Response example:
{
"status":1,
"pixel":{
"id":2,
"name":"test",
"code":"\u003Cscript\u003Etest\u003C\/script\u003E",
"code_type":"javascript",
"offer_id":"906",
"pid":"610",
"is_active":"0",
"moderation_status":"0",
"created_at":"2017-06-21 03:34:51",
"updated_at":"2017-06-21 03:34:51"
}
}
Add a partner’s pixel
POST /3.0/partner/pixel
Parameter Type Available & Default Description offer_id Integer REQUIRED Offer’s
ID name String REQUIRED Name code String Available: <script>…code…</scipt>, <img
…>, <iframe src=“…”></iframe> REQUIRED Code code_type String Available:
javascript, iframe, image REQUIRED Code type
PIXEL EDIT
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "pid=610&offer_id=906&name=test2&code=<script>test2</script>&code_type=javascript" http://YOUR_API_DOMAIN/3.0/partner/pixel/2
> Response example:
{
"status":1,
"pixel":{
"id":2,
"name":"test2",
"code":"\u003Cscript\u003Etest2\u003C\/script\u003E",
"code_type":"javascript",
"offer_id":"906",
"pid":"610",
"is_active":"0",
"moderation_status":"0",
"created_at":"2017-06-21 03:34:51",
"updated_at":"2017-06-21 03:34:51"
}
}
Edit a partner’s pixel
POST /3.0/partner/pixel/{ID}
Parameter Type Available & Default Description name String Name code String
Available: <script>…code…</scipt>, <img …>, <iframe src=“…”></iframe> Code
code_type String Available: javascript, iframe, image Code type
PIXEL REMOVE
curl -X DELETE --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/partner/pixel/2/remove
> Response example:
{
"status":1,
"pixel":{
"id":2,
"name":"test2",
"code":"\u003Cscript\u003Etest2\u003C\/script\u003E",
"code_type":"javascript",
"offer_id":"906",
"pid":"610",
"is_active":"0",
"moderation_status":"0",
"created_at":"2017-06-21 03:34:51",
"updated_at":"2017-06-21 03:34:51"
}
}
Delete a partner’s pixel
DELETE /3.0/partner/pixel/{ID}/remove
AFFILIATE BALANCE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/balance
> Response example:
{
"status":1,
"balance":{
"balance":{
"USD":0,
"EUR":0,
"RUB":16968
},
"hold":{
"USD":0,
"EUR":0,
"RUB":1234
},
"available":{
"USD":0,
"EUR":0,
"RUB":15734
}
}
}
Get current affiliate balance
GET /3.0/balance
SMARTLINK CATEGORIES
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/partner/smartlink/categories
> Response example:
{
"status":1,
"data":[
{
"_id":"595e3b547e28fede7b8b456c",
"name":"test1",
"domain":"myDomen.com",
"use_https":false,
"description":null,
"created_at":"2017-07-06 13:29:56"
}
]
}
SmartLink categories list
GET /3.0/partner/smartlink/categories
Parameter Type Available & Default Description id Array[string] SmartLink
categories ID collections
SMARTLINK OFFER COUNT
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "" http://YOUR_API_DOMAIN/3.0/partner/smartlink/category/595fd4877e28fee8428b459f/offers-count
> Response example:
{
"status":1,
"data":{
"count":2
}
}
Add new SmartLink category
GET /3.0/partner/smartlink/category/{id}/offers-count
GET REFERRALS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "" http://YOUR_API_DOMAIN/3.0/admin/partner/{ID}/referrals
> Response example:
{
"status": 1,
"referrals": [
{
"id": 2,
"created_at": "2019-05-04 16:55:58",
"updated_at": "2019-05-04 16:57:32",
"email": "email@domain.aff",
"login": "login",
"ref_percent": null,
"name": null,
"notes": "Notes",
"manager": null,
"status": "active",
"level": 0,
"payment_systems": [
{
"id": 1,
"active": 0,
"system": "Webmoney",
"fields": {
"1": "11111",
"2": "22222"
}
}
],
"customFields": [
{
"name": "Skype",
"value": "skype",
"label": "skype",
"id": 1
}
],
"balance": {
"RUB": {
"balance": 0,
"hold": 0,
"available": 0
},
"USD": {
"balance": 0,
"hold": 0,
"available": 0
},
"EUR": {
"balance": 0,
"hold": 0,
"available": 0
},
"BTC": {
"balance": 0,
"hold": 0,
"available": 0
}
},
"offersCount": 1,
"api_key": "api_key",
"address_1": "adress 1",
"address_2": "adress 2",
"city": "New York",
"country": "US",
"zip_code": "220089",
"phone": "375291111111",
"ref": "1",
"sub_accounts": {
"1": {
"value": "",
"except": 0
},
"2": {
"value": "",
"except": 0
}
}
}
],
"pagination": {
"per_page": 100,
"total_count": 1,
"page": 1
}
}
Get referrals by partner ID
GET /3.0/admin/partner/{id}/referrals
CHANGE PARTNER API KEY
curl -X POST \
'http://YOUR_API_DOMAIN/3.1/partner/api-key' \
-H 'api-key: {API-KEY}'
> Response example:
{
"status": 1,
"user": {
"id": 1,
"api_key": "97366c88ad626fdf4c73687d2cae5394"
}
}
Change partner api key
POST /3.1/partner/api-key
IMPORT SINGLE CONVERSION
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "offer=1000&pid=500" http://YOUR_API_DOMAIN/3.0/admin/conversion/import
> Response example:
{
"status": 1,
"data": {
"offer": 1000,
"pid": 500,
"action_id": null,
"goal": null,
"ip": null,
"ua": null,
"sum": null,
"comment": null
},
"message": "Conversion import will take a few minutes"
}
Import a single conversion
POST /4.0/affiliate/conversion/import
Parameter Type Available & Default Description offer Integer REQUIRED Offer id
action_id String advertiser conversion id click_id String Click ID goal Integer
goal number ip String visitor ip ua String visitor user-agent comment String
comment custom_field_1 String custom field 1 custom_field_2 String custom field
2 custom_field_3 String custom field 3 custom_field_4 String custom field 4
custom_field_5 String custom field 5 custom_field_6 String custom field 6
custom_field_7 String custom field 7 created_at String Available: YYYY-MM-DD not
later than 2 month from Default: now Created at
IMPORT MULTIPLE CONVERSIONS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "list[0][offer]=1000&list[0][pid]=500" http://YOUR_API_DOMAIN/3.0/admin/conversions/import
> Response example:
{
"status": 1,
"data": {
"list": [
{
"offer": 1000,
"pid": 500,
"action_id": null,
"goal": null,
"ip": null,
"ua": null,
"sum": null,
"comment": null
}
]
},
"message": "Conversion import will take a few minutes"
}
Import multiple conversions
POST /4.0/affiliate/conversions/import
Parameter Type Available & Default Description list[0][offer] Integer REQUIRED
Offer id list[0][action_id] String advertiser conversion id list[0][click_id]
String Click ID list[0][goal] Integer goal number list[0][ip] String visitor ip
list[0][ua] String visitor user-agent list[0][comment] String comment
list[0][custom_field_1] String custom field 1 list[0][custom_field_2] String
custom field 2 list[0][custom_field_3] String custom field 3
list[0][custom_field_4] String custom field 4 list[0][custom_field_5] String
custom field 5 list[0][custom_field_6] String custom field 6
list[0][custom_field_7] String custom field 7 list[0][created_at] String
Available: YYYY-MM-DD not later than 2 month from Default: now Created at
OFFERS
OFFERS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/offers
> Response example:
{
"status":1,
"offers":[
{
"id": 331,
"offer_id": "5bdffa7339f65625008b4568",
"advertiser": "5bc9d7c16d73e41c008b4567",
"external_offer_id": "",
"bundle_id": "",
"hide_payments": false,
"title": "blabla",
"macro_url": "",
"url": "",
"cross_postback_url":"http:\/\/test-url.com",
"cross_postback_method": "post",
"cross_postback_body": "test data",
"url_preview": "",
"preview_url": "",
"domain_url": "test.com",
"parallel_tracking_url": "",
"trafficback_url": "",
"use_https": true,
"use_http": true,
"description_lang": {
"it" : "Descrizione",
"en" : "Description"
},
"sources": [
{
"id": "51f531f53b7d9b1e0382f6d9",
"title": "Web sites",
"allowed": 1
}
],
"logo": "http:\/\/YOUR_API_DOMAIN\/images\/cpa\/logos\/787450449.jpeg",
"logo_source": "",
"status": "active",
"privacy": "public",
"is_top": 0,
"payments": [
{
"countries": [
"kz"
],
"cities": [
{
"country_code": "KZ",
"id": 563497,
"name": "Maksut",
"region_code": "Qostanay Oblysy"
}
],
"devices": [],
"os": [],
"goal": "1",
"revenue": 500,
"currency": "usd",
"title": "goal1",
"type": "fixed",
"country_exclude": false,
"total": 1000,
"with_regions": false,
"url": null,
"sub1": null,
"sub2": null,
"sub3": null,
"sub4": null,
"sub5": null,
"sub6": null,
"sub7": null,
"sub8": null
}
],
"partner_payments": [],
"landings": [
{
"id": 1,
"title": "...",
"url": "http://YOUR_API_DOMAIN/l1/",
"url_preview": "http://YOUR_API_DOMAIN/l1/",
"type": "landing"
}
],
"strictly_country": 0,
"strictly_os": null,
"strictly_brands": [],
"strictly_connection_type": null,
"restriction_isp": null,
"is_redirect_overcap": false,
"notice_percent_overcap": 0,
"hold_period": 0,
"hold_type": "days",
"categories": [
"...",
"..."
],
"full_categories": [
{
"id": "5368afb23b7d9b4d5d505342",
"title": "..."
},
{
"id": "55b204663b7d9b460b8b45b2",
"title": "..."
}
],
"cr": 0,
"epc": 0,
"notes": "",
"allowed_ip": "",
"disallowed_ip": "",
"hash_password": "",
"allow_deeplink": false,
"hide_referer": false,
"start_at": "2018-11-06 12:35:00",
"stop_at": "",
"auto_offer_connect": 0,
"required_approval": false,
"is_cpi": false,
"creatives": [],
"creatives_zip": null,
"created_at": "2018-11-05 11:08:19",
"sub_accounts": {
"1": {
"value": "",
"except": false
},
"2": {
"value": "",
"except": false
}
},
"disabled_by": "",
"kpi": {
"ru": "",
"en": "",
"es": "",
"ka": "",
"vi": ""
},
"strictly_isp": [],
"caps": [
{
"period": "day",
"type": "conversions",
"value": 100,
"goal_type": "exact",
"goals": {
"1": "Install"
},
"affiliate_type": "exact",
"affiliates": [
500,
600
],
"country": null,
"country_type": "all"
},
{
"period": "month",
"type": "budget",
"value": 100,
"goal_type": "each",
"goals": [],
"affiliate_type": "each",
"affiliates": []
},
{
"period": "all",
"type": "budget",
"value": 100,
"goal_type": "all",
"goals": [],
"affiliate_type": "all",
"affiliates": [],
"country": null,
"country_type": "all"
}
],
"updated_at": "2021-06-30 17:40:36",
"caps_goal_overcap": "",
"targeting": [
{
"country": {
"allow": [],
"deny": []
},
"region": {
"allow": [],
"deny": []
},
"city": {
"allow": [],
"deny": []
},
"os": {
"allow": [],
"deny": []
},
"isp": {
"allow": [],
"deny": []
},
"ip": {
"allow": [],
"deny": []
},
"browser": {
"allow": [],
"deny": []
},
"brand": {
"allow": [],
"deny": []
},
"device_type": [],
"connection": [],
"affiliate_id": [],
"sub": {
"allow": [],
"deny": [],
"deny_groups": []
},
"id": "d10653b0-d68d-4b09-abea-be870cabe364",
"block_proxy": false
}
],
"commission_tiers" : [
{
"id": "e9efcde8-949d-4979-b5d4-14d50da79f16",
"affiliate_type": "exact",
"affiliates": [
1
],
"goals": [],
"timeframe": "month",
"type": "budget",
"value": 55.6,
"target_goals": [],
"modifier_type": "to_percent",
"modifier_value": 10.02,
"modifier_payment_type": "payout",
"countries": []
}
],
"enabled_commission_tiers": true,
"consider_personal_targeting_only": false,
"hosts_only": false,
"allow_impressions": false,
"impressions_url": "",
"smartlink_categories": [],
"uniq_ip_only": false,
"reject_not_uniq_ip": 0,
"tags": [],
"duplicate_clicks_threshold": 0
}
],
"pagination":{
"per_page":1,
"total_count":176,
"page":1,
"next_page":2
}
}
Get a list of offers
GET /3.0/offers
Parameter Type Available & Default Description q String Search by title and id
int_id Array[integer] Search by one or more offer IDs countries Array[string]
Array of offers countries(ISO) os Array[string] Available: Windows, webOS,
macOS, iPadOS, iOS, Android OS categories Array[string] Array of offers
categories caps_type String Caps type. Values: clicks, conversions, budget,
impressions. This filter will not show offers for the selected cap type if the
cap is full caps_country String Caps country in ISO 3166-1 format. Values: IT,
BR, AM, RO…. sort Array[string] Sort offers. Sample sort[id]=asc,
sort[title]=desc. You can sort offers by one of (id, title, cr, epc, is_top,
created, revenue, daily_cap, total_cap) page Integer Page of offers limit
Integer Default: 100
Available: max 500 Count offers by page status Array[string] Default: active
Available: active, stopped, suspended Statuses stopped and suspended ONLY FOR
ADMIN . Status active allowed for NON ADMIN advertiser Array[String] ONLY FOR
ADMIN Advertiser ID privacy Array[integer] ONLY FOR ADMIN Privacy filter:
Public(0), Premoderated(1), Private(2) updated_at String Get offers that have
been updated from this date (format YYYY-MM-DD) is_top Integer Available: 0, 1
Get TOP-offers bundle_id String ONLY FOR ADMIN Search by bundle id
smartlink_categories Array[string] Array of smartlinks IDs advertiser_manager_id
Array[string] ONLY FOR ADMIN Array of advertiser managers IDs external_offer_id
String External offer id additional_fields String ONLY FOR ADMIN Sample:
additional_fields=enabled_affiliates
OFFER BY ID
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/offer/906
> Response example:
{
"status":1,
"offer":{
"id": 906,
"offer_id": "5721f8e03b7d9b7f058b4568",
"advertiser": "56cc49dc3b7d9b89058b45f0",
"external_offer_id": false,
"bundle_id": "46cc97dc3b7d9b10758b45f0",
"hide_payments": false,
"title": "",
"macro_url": "",
"url": "http://.../desktop/1/?w=32&t=...&a1={clickid}&a5={pid}",
"parallel_tracking_url": "",
"cross_postback_url":"http:\/\/test-url.com",
"cross_postback_method": "post",
"cross_postback_body": "test data",
"url_preview": "http://.../desktop/1/",
"preview_url": "http://.../desktop/1/",
"domain_url": "YOUR_API_DOMAIN",
"use_https": true,
"use_http": true,
"description_lang": {
"ru": "",
"en": "",
"es": "",
"ka": "",
"vi": ""
},
"sources": [
"51f531f53b7d9b1e0382f6d9",
"51f532053b7d9b340eea741a",
"51f532103b7d9b340e325f1c",
"51f5322d3b7d9b340eabb872",
"51f532393b7d9b5e030908a0",
"51f5325e3b7d9b340e8a2b79",
"51f532713b7d9b5e03b24520",
"51f532873b7d9b5e03e88a74",
"5432ffe43b7d9b615f4f7f2a",
"5432fff93b7d9b615fab559d"
],
"logo": "/images/cpa/logos/4228614618.png",
"logo_source": null,
"status": "active",
"privacy": "public",
"is_top": 0,
"payments": [
{
"countries": [],
"cities": [],
"devices": [],
"os": [],
"goal": "1",
"total": 1020,
"revenue": 800,
"currency": "USD",
"title": "...",
"type": "fixed",
"url": null,
"country_exclude": false,
"with_regions": false
},
{
"countries": [],
"cities": [],
"devices": [],
"os": [],
"goal": "4",
"total": 1600,
"revenue": 1020,
"currency": "USD",
"title": "...",
"type": "fixed",
"url": null,
"country_exclude": false,
"with_regions": false
},
{
"countries": [],
"cities": [],
"devices": [],
"os": [
"Mac OS X"
],
"goal": "1",
"total": 12345,
"revenue": 1234,
"currency": "usd",
"title": "",
"type": "fixed",
"url": null,
"country_exclude": false,
"with_regions": false
}
],
"partner_payments": [
{
"countries": [],
"cities": [],
"devices": [],
"os": [],
"goal": "2",
"total": 1600,
"revenue": 900,
"currency": "usd",
"title": "...",
"type": "fixed",
"url": null,
"country_exclude": false,
"with_regions": false,
"partners": [
610
]
}
],
"landings": [],
"strictly_country": 0,
"strictly_os": [],
"strictly_brands": null,
"strictly_connection_type": "",
"is_redirect_overcap": false,
"notice_percent_overcap": 0,
"hold_period": 0,
"hold_type": "days",
"categories": [],
"full_categories": [],
"cr": 1.21,
"epc": 9.58,
"notes": null,
"allowed_ip": "",
"disallowed_ip": "",
"hash_password": "",
"allow_deeplink": 0,
"hide_referer": 0,
"start_at": "2018-11-05 12:35:00",
"stop_at": null,
"auto_offer_connect": null,
"required_approval": false,
"is_cpi": false,
"kpi": {
"ru": "",
"en": "",
"es": "",
"ka": "",
"vi": ""
},
"sub_restrictions": [],
"creatives": [],
"creatives_zip": null,
"sub_accounts": {
"1": {
"value": "",
"except": false
},
"2": {
"value": "",
"except": false
}
},
"redirect_type": "http302",
"caps": [
{
"period": "day",
"type": "conversions",
"value": 100,
"goal_type": "exact",
"goals": {
"1": "Install",
"2": "Register"
},
"affiliate_type": "exact",
"affiliates": [
500,
600
],
"country": null,
"country_type": "all"
},
{
"period": "month",
"type": "budget",
"value": 100,
"goal_type": "each",
"goals": {},
"affiliate_type": "each",
"affiliates": [],
"country": null,
"country_type": "all"
},
{
"period": "all",
"type": "budget",
"value": 100,
"goal_type": "all",
"goals": {},
"affiliate_type": "all",
"affiliates": [],
"country": null,
"country_type": "all"
}
],
"caps_timezone": "Europe/Moscow",
"strictly_isp": [],
"restriction_isp": null,
"strictly_devices": null,
"disabled_choice_postback_status": false,
"updated_at": "2021-06-30 17:53:18",
"created_at": "2021-06-23 17:10:59",
"caps_status": [
"confirmed",
"pending",
"declined",
"hold"
],
"caps_goal_overcap": "",
"search_empty_sub": null,
"targeting": [
{
"country": {
"allow": [],
"deny": []
},
"region": {
"allow": [],
"deny": []
},
"city": {
"allow": [],
"deny": []
},
"os": {
"allow": [],
"deny": []
},
"isp": {
"allow": [],
"deny": []
},
"ip": {
"allow": [],
"deny": []
},
"browser": {
"allow": [],
"deny": []
},
"brand": {
"allow": [],
"deny": []
},
"device_type": [],
"connection": [],
"affiliate_id": [],
"sub": {
"allow": [],
"deny": [],
"deny_groups": []
},
"id": "d10653b0-d68d-4b09-abea-be870cabe364",
"block_proxy": false
}
],
"commission_tiers" : [
{
"id": "e9efcde8-949d-4979-b5d4-14d50da79f16",
"affiliate_type": "exact",
"affiliates": [
1
],
"goals": [],
"timeframe": "month",
"type": "budget",
"value": 55.6,
"target_goals": [],
"modifier_type": "to_percent",
"modifier_value": 10.02,
"modifier_payment_type": "payout",
"countries": []
}
],
"enabled_commission_tiers": true,
"schedule": {
"enabled": false,
"date_start": "",
"date_to": "",
"timezone": "Europe/Moscow",
},
"consider_personal_targeting_only": false,
"hosts_only": false,
"allow_impressions": false,
"impressions_url": "",
"smartlink_categories": [],
"uniq_ip_only": false,
"reject_not_uniq_ip": 0,
"tags": [],
"duplicate_clicks_threshold": 0
}
}
Get full information of an offer
GET /3.0/offer/{ID}
Parameter Type Available & Default Description id Integer
CATEGORIES
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/offer/categories
> Response example:
{
"status":1,
"categories":[
{
"id":"5368a3973b7d9b4d5d59f1ca",
"title":"..."
}
],
"pagination":{
"per_page":1,
"total_count":11,
"page":1,
"next_page":2
}
}
List of a categories
GET /3.0/offer/categories
Parameter Type Available & Default Description ids Array[string] Search by IDs
page Integer Page of entities limit Integer Default: 99999
Available: max 99999 Limit of entities orderType String Default: asc
Available: asc, desc order String Default: id
Available: id, title
ADVERTISER MANAGING (ADMIN METHODS)
GET ADVERTISER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/advertiser/{id}
> Response example:
{
"advertiser": {
"address_1": null,
"address_2": null,
"allowed_ip": [],
"city": "Los Angeles",
"consider_personal_targeting_only": false,
"contact": "John Doe",
"country": "US",
"created_at": "2023-02-22 15:11:09",
"updated_at": "2023-02-22 15:11:09",
"disabled_choice_postback_status": false,
"disallowed_ip": [],
"email": "adv@gmail.com",
"hash_password": "e6277f0201b26c2c0bb5fcf8bdf25997",
"hide_conversion_status": false,
"hosts_only": false,
"id": "5b5f415035752723008b456a",
"manager": "63f5ecb90ed3182eb3dba530",
"manager_obj": {
"api_key": "c40469ac42533296ac6c638f392b2ece",
"avatar": null,
"created_at": "2023-04-20 17:21:40",
"email": "new-user@gmail.com",
"facebook": "facebook",
"first_name": "John",
"id": "64413c649b70ab801d9b9a71",
"last_login_at": null,
"last_name": "Doe",
"roles": [
"ROLE_ADMIN"
],
"skype": "skype",
"telegram": "telegram",
"type": "common_manager",
"updated_at": "2023-04-20 17:21:40",
"username": "64413c649b70ab801d9b9a71",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"work_hours": null
},
"note": null,
"sign_clicks_integration": "no_sign",
"skad_network_id": [],
"skype": "456345345",
"sub_accounts": {
"1": {
"except": false,
"value": null
},
"2": {
"except": false,
"value": null
}
},
"tags": [],
"title": "Test supplier",
"url": null,
"vat_code": null,
"zip_code": null,
"affiliates_enabled": [{
"id": 1,
"name": "Affiliate"
}],
"affiliates_disabled": []
},
"status": 1
}
Get advertiser
GET /3.0/admin/advertiser/{id}
ADVERTISERS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/advertisers
> Response example:
{
"status":1,
"advertisers":[
{
"address_1": "Address 1",
"address_2": null,
"allowed_ip": [],
"city": "Berlin",
"consider_personal_targeting_only": false,
"contact": "Samuel",
"country": "DE",
"created_at": "2023-02-17 18:29:42",
"updated_at": "2023-02-17 18:29:42",
"disallowed_ip": [],
"email": "adv@gmail.com",
"has_user": false,
"hash_password": null,
"hide_conversion_status": false,
"hosts_only": false,
"id": "63ef8f56d05af8acc266ae09",
"manager": "Sales Manager",
"manager_obj": {
"api_key": "c40469ac42533296ac6c638f392b2ece",
"avatar": null,
"created_at": "2023-04-20 17:21:40",
"email": "new-user@gmail.com",
"facebook": "facebook",
"first_name": "John",
"id": "64413c649b70ab801d9b9a71",
"last_login_at": null,
"last_name": "Doe",
"roles": [
"ROLE_ADMIN"
],
"skype": "skype",
"telegram": "telegram",
"type": "common_manager",
"updated_at": "2023-04-20 17:21:40",
"username": "64413c649b70ab801d9b9a71",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"work_hours": null
},
"note": null,
"offers": 0,
"sign_clicks_integration": "no_sign",
"skad_network_id": [],
"skype": "32543543",
"sub_accounts": {
"1": {
"except": false,
"value": null
},
"2": {
"except": false,
"value": null
}
},
"tags": [],
"title": "Advertiser",
"url": "http:\/\/YOUR_API_DOMAIN",
"vat_code": null,
"zip_code": null,
"affiliates_enabled": [{
"id": 1,
"name": "Affiliate"
}],
"affiliates_disabled": []
}
],
"pagination":{
"per_page":100,
"total_count":183,
"page":1,
"next_page":2
}
}
Get a list of advertisers
GET /3.0/admin/advertisers
Parameter Type Available & Default Description page Integer Page of entities
limit Integer Default: 100
Available: max 500 Limit of entities order String Default: _id
Available: _id, title, email Sort by field orderType String Default: asc
Available: desc, asc Sorting order updated_at String Get advertisers that have
been updated from this date (format YYYY-MM-DD) with_offers Integer Available: 1
Show advertisers with offers
ADD ADVERTISER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "title=MyTitle&contact=ThePerson&skype=MySkype&manager=5747f68c3b7d9be4018b4570" http://YOUR_API_DOMAIN/3.0/admin/advertiser
> Response example:
{
"advertiser": {
"address_1": "address 1",
"address_2": "address 2",
"allowed_ip": [],
"city": "Lisbon",
"consider_personal_targeting_only": true,
"contact": "John Doe",
"country": "PT",
"created_at": "2023-04-17 11:32:06",
"updated_at": "2023-04-17 11:32:06",
"disallowed_ip": [],
"email": "adv-test6@gmail.com",
"hash_password": null,
"hide_conversion_status": false,
"hosts_only": false,
"id": "643cf5f6b49e5edafb231b40",
"manager": "5cd55442d596c1c7008b4567",
"manager_obj": {
"api_key": "c40469ac42533296ac6c638f392b2ece",
"avatar": null,
"created_at": "2023-04-20 17:21:40",
"email": "new-user@gmail.com",
"facebook": "facebook",
"first_name": "John",
"id": "64413c649b70ab801d9b9a71",
"last_login_at": null,
"last_name": "Doe",
"roles": [
"ROLE_ADMIN"
],
"skype": "skype",
"telegram": "telegram",
"type": "common_manager",
"updated_at": "2023-04-20 17:21:40",
"username": "64413c649b70ab801d9b9a71",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"work_hours": null
},
"note": null,
"sign_clicks_integration": "no_sign",
"skad_network_id": [],
"skype": "123123",
"sub_accounts": {
"1": {
"except": false,
"value": null
},
"2": {
"except": false,
"value": null
}
},
"tags": [
"mobile"
],
"title": "Market Inc",
"url": "http://example.com",
"vat_code": null,
"zip_code": null,
"disabled_choice_postback_status": true,
"affiliates_enabled": [1, 2],
"affiliates_disabled": [3, 4]
},
"status": 1
}
Add new advertiser
POST /3.0/admin/advertiser
Parameter Type Available & Default Description title String REQUIRED Company
name contact String Contact person name skype String IM/Skype manager String
Manager ID url String Site Url email String Email password String Password: 8 or
up to 30 characters with at least one uppercase, at least one lowercase, at
least one numeric digit, at least one of the allowed special characters listed:
_-!@*.$%?&#/|\~<>^{}[]():; allowed_ip String Allowed IP. Example:
127.0.0.1\n127.0.1.1-127.0.2.1 address_1 String Main address string address_2
String Additional address city String City name country String Country ISO name
zip_code String Zip code vat_code String Vat code sub_account_1 String Available
only letters(a-z), numbers(0-9) and these symbols: ,._-{}+=/:~ Allowed sub1
values sub_account_2 String Available only letters(a-z), numbers(0-9) and these
symbols: ,._-{}+=/:~ Allowed sub2 values sub_account_1_except Integer Default: 0
Available: 0, 1 Block sub1 values sub_account_2_except Integer Default: 0
Available: 0, 1 Block sub2 values consider_personal_targeting_only String
Available: true/false tags Array[string] An array of advertiser’s tags
hash_password String Secure postback code skad_network_id Array[string] An array
of SkadNetwork IDs disabled_choice_postback_status Bool Forbid the affiliates
from changing the postback status (for all the offers of this advertiser): true
or false affiliates_enabled Array[Integer] An array of Affiliate IDs
affiliates_disabled Array[Integer] An array of Affiliate IDs
EDIT ADVERTISERS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "title=MyTitle2&contact=ThePerson2&skype=MySkype2&manager=5747f68c3b7d9be4018b4570" http://YOUR_API_DOMAIN/3.0/admin/advertiser/59490d317e28febe1e8b456c
> Response example:
{
"advertiser": {
"address_1": "address 1",
"address_2": "address 2",
"allowed_ip": [],
"city": "Lisbon",
"consider_personal_targeting_only": true,
"contact": "John Doe",
"country": "PT",
"created_at": "2023-04-17 11:32:06",
"updated_at": "2023-04-17 11:40:18",
"disallowed_ip": [],
"email": "adv-test6@gmail.com",
"hash_password": "b5ecd86502e9bdfba8d1dc16444b4602",
"hide_conversion_status": false,
"hosts_only": false,
"id": "643cf5f6b49e5edafb231b40",
"manager": "5cd55442d596c1c7008b4567",
"manager_obj": {
"api_key": "c40469ac42533296ac6c638f392b2ece",
"avatar": null,
"created_at": "2023-04-20 17:21:40",
"email": "new-user@gmail.com",
"facebook": "facebook",
"first_name": "John",
"id": "64413c649b70ab801d9b9a71",
"last_login_at": null,
"last_name": "Doe",
"roles": [
"ROLE_ADMIN"
],
"skype": "skype",
"telegram": "telegram",
"type": "common_manager",
"updated_at": "2023-04-20 17:21:40",
"username": "64413c649b70ab801d9b9a71",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"work_hours": null
},
"note": null,
"sign_clicks_integration": "no_sign",
"skad_network_id": [],
"skype": "123123",
"sub_accounts": {
"1": {
"except": false,
"value": null
},
"2": {
"except": false,
"value": null
}
},
"tags": [
"mobile"
],
"title": "Market Inc",
"url": "http://example.com",
"vat_code": null,
"zip_code": null,
"disabled_choice_postback_status": true,
"affiliates_enabled": [1, 2],
"affiliates_disabled": [3, 4]
},
"status": 1
}
Change an advertiser’s data
POST /3.0/admin/advertiser/{ID}
Parameter Type Available & Default Description title String Company name contact
String Contact person name skype String IM/Skype manager String Manager ID url
String Site Url email String Email password String Password: 8 or up to 30
characters with at least one uppercase, at least one lowercase, at least one
numeric digit, at least one of the allowed special characters listed:
_-!@*.$%?&#/|\~<>^{}[]():; allowed_ip String Allowed IP. Example:
127.0.0.1\n127.0.1.1-127.0.2.1 note String Note allowed_ip String Allowed IP
address_1 String Main address string address_2 String Additional address city
String City name country String Country ISO name zip_code String Zip code
vat_code String Vat code sub_account_1 String Sub1 list, separated by commas
sub_account_2 String Sub2 list, separated by commas sub_account_1_except Integer
Default: 0
Available: 0, 1 Except Sub1 list sub_account_2_except Integer Default: 0
Available: 0, 1 Except Sub2 list consider_personal_targeting_only String
Available: true/false tags Array[string] An array of tags (All the previous tags
will be overwritten by new ones) sign_clicks_integration String Available:
no_sign,appsflyer,kochava Click Signature Service hash_password String Secure
postback code skad_network_id Array[string] An array of SkadNetwork IDs (All the
IDs will be overwritten by new ones) disabled_choice_postback_status Bool Forbid
the affiliates from changing the postback status (for all the offers of this
advertiser): true or false affiliates_enabled Array[Integer] An array of
Affiliate IDs affiliates_disabled Array[Integer] An array of Affiliate IDs
SEND PASSWORD TO ADVERTISER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "" http://YOUR_API_DOMAIN/3.0/admin/advertiser/59490d317e28febe1e8b456c/sendpass
> Response example:
{
"status":1,
"message":"Email send successfully"
}
Change an advertiser password and send it by email
POST /3.0/admin/advertiser/{ID}/sendpass
ADVERTISERS ENABLE AFFILIATE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "advertisers_id=56fce8ab3b7d9b95588b4568&pid=610" http://YOUR_API_DOMAIN/3.0/admin/advertiser/enable-affiliate
> Response example:
{
"status":1,
"message":"Request is successfully: Partner #610 doesn\u0027t exist in blacklist for advertiser 56fce8ab3b7d9b95588b4568"
}
Un-put affiliate from blacklist for specified advertisers
POST /3.0/admin/advertiser/enable-affiliate
Parameter Type Available & Default Description advertisers_id Array[string]
REQUIRED Array of advertiser IDs to connect pid Integer REQUIRED affiliate ID
ADVERTISERS DISABLE AFFILIATE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "advertisers_id=56fce8ab3b7d9b95588b4568&pid=610" http://YOUR_API_DOMAIN/3.0/admin/advertiser/disable-affiliate
> Response example:
{
"status":1,
"message":"Request is successfully"
}
Put affiliate to blacklist for specified advertisers
POST /3.0/admin/advertiser/disable-affiliate
Parameter Type Available & Default Description advertisers_id Array[string]
REQUIRED Array of advertiser IDs to connect pid Integer REQUIRED affiliate ID
ADVERTISER BILLING MANAGING (ADMIN METHODS)
INVOICES LIST
curl -X GET \
http://<YOUR_DOMAIN>/3.0/admin/advertiser-invoices \
-H 'api-key: d4735cd4fbf4ba08729cf3256c358ebefffb6f9d' \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-H 'postman-token: 97d09049-050c-58ce-9eaf-5997b72f1eb2' \
> Response example:
{
"status": 1,
"message": [
{
"number": 1,
"supplier_id": "5a37c01cbf0b6b18008b4567",
"created_at": "2018-01-11",
"updated_at": "2018-01-11",
"start_date": "2017-12-05",
"end_date": "2017-12-07",
"status": "unpaid",
"detail": [
{
"offer_id": 1,
"payout_type": "RPA",
"actions": 100,
"amount": 100,
"comment": null
}
],
"currency": "USD",
"comment": null
},
{
"number": 2,
"supplier_id": "5a37c01cbf0b6b18008b4567",
"created_at": "2018-01-11",
"updated_at": "2018-01-11",
"start_date": "2018-01-11",
"end_date": "2018-01-11",
"status": "unpaid",
"detail": [
{
"offer_id": 1,
"payout_type": "RPA",
"actions": 55,
"amount": 666,
"comment": null
}
],
"currency": "USD",
"comment": "some comment"
}
],
"pagination": {
"per_page": 100,
"total_count": 2,
"page": 1
}
}
Get list of invoices
GET /3.0/admin/advertiser-invoices
Parameter Type Available & Default Description page Integer Page of entities
limit Integer Default: 100
Available: max 500 Limit of entities status String Available: paid, unpaid
Status of invoice start_date String Start date of period end_date String End
date of period
INVOICES VIEW
curl -X GET \
http://YOUR_API_DOMAIN/3.0/admin/advertiser-invoice/1 \
-H 'api-key: d4735cd4fbf4ba08729cf3256c358ebefffb6f9d' \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-H 'postman-token: 30c120cf-00ba-1689-4171-a927baa21844' \
> Response example:
{
"status": 1,
"message": {
"number": 1,
"supplier_id": "5a37c01cbf0b6b18008b4567",
"created_at": "2018-01-11",
"updated_at": "2018-01-11",
"start_date": "2017-12-05",
"end_date": "2017-12-07",
"status": "paid",
"detail": [
{
"offer_id": 1,
"payout_type": "RPA",
"actions": 100,
"amount": 100,
"comment": null
}
],
"currency": "USD",
"comment": null
}
}
Get a invoice
GET /3.0/admin/advertiser-invoice/{number}
ADD INVOICE
curl -X POST \
http://YOUR_API_DOMAIN/3.0/admin/advertiser-invoice \
-H 'api-key: d4735cd4fbf4ba08729cf3256c358ebefffb6f9d' \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F status=unpaid \
-F supplier_id=5a37c01cbf0b6b18008b4567 \
-F start_date=2017-12-05 \
-F 'detail[1][offer_id]=1' \
-F 'detail[1][payout_type]=RPA' \
-F 'detail[1][amount]=100' \
-F 'detail[1][actions]=100' \
-F end_date=2017-12-07 \
-F currency=USD \
-F comment=222
> Response example:
{
"status": 1,
"message": "Invoice created."
}
Add new invoice
POST /3.0/admin/advertiser-invoice
Parameter Type Available & Default Description supplier_id String REQUIRED
Advertiser Id start_date String Start date of invoice period end_date String End
date of invoice period status String [paid, unpaid] Invoice status currency
String REQUIRED One of the active currencies (RUB, USD, EUR etc) comment String
Comment detail[][offer_id] integer Offer id detail[][payout_type] string
[RPA,RPS,RPA + RPS,RPC, RPM] Payout type detail[][actions] integer Actions
detail[][amount] integer Amount detail[][comment] string Comment for detail
EDIT INVOICE
curl -X POST \
http://YOUR_API_DOMAIN/3.0/admin/advertiser-invoice/1 \
-H 'api-key: d4735cd4fbf4ba08729cf3256c358ebefffb6f9d' \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F status=unpaid
> Response example:
{
"status": 1,
"message": "Invoice updated"
}
Change an invoice’s data
POST /3.0/admin/advertiser-invoice/{number}
Parameter Type Available & Default Description supplier_id String REQUIRED
Advertiser Id start_date String Start date of invoice period end_date String End
date of invoice period status String [paid, unpaid] Invoice status comment
String Comment detail[][offer_id] integer Offer id detail[][payout_type] string
[RPA,RPS,RPA + RPS,RPC, RPM] Payout type detail[][actions] integer Actions
detail[][amount] integer Amount detail[][comment] string Comment for detail
OFFER MANAGING (ADMIN METHODS)
COUNT OF ACTIVE OFFERS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/offers/count
> Response example:
{
"status": 1,
"count": 8
}
Get count of offers in status ‘active’
GET /3.0/offers/count
ADD OFFER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "title=test&advertiser=573c69a33b7d9b0e638b4576&url=http://example.com&url_preview=http://preview.example.com" http://YOUR_API_DOMAIN/3.0/admin/offer
> Response example:
{
"status":1,
"offer":{
"id":936,
"offer_id":"5943f7307e28fe9a1f8b456d",
"advertiser":"573c69a33b7d9b0e638b4576",
"hide_payments":false,
"title":"test",
"macro_url":null,
"url":"http:\/\/YOUR_API_DOMAIN",
"cross_postback_url":"http:\/\/test-url.com",
"cross_postback_method": "post",
"cross_postback_body": "test data",
"url_preview":"http:\/\/preview.YOUR_API_DOMAIN",
"preview_url":"http:\/\/preview.YOUR_API_DOMAIN",
"domain_url":"YOUR_API_DOMAIN",
"use_https":false,
"use_http":true,
"description_lang": {
"ru" : "Описание",
"en" : "Description"
},
"sources":[
],
"logo":"\/images\/cpa\/logos\/",
"status":"stopped",
"tags":["default"],
"privacy":"public",
"is_top":0,
"payments":[
],
"partner_payments":[
],
"landings":[
],
"strictly_country":0,
"strictly_os":{},
"strictly_connection_type": "wi-fi",
"is_redirect_overcap":false,
"notice_percent_overcap":null,
"hold_period":0,
"hold_type":"days",
"categories":[
],
"full_categories":[
],
"cr":0,
"epc":0,
"notes":null,
"allowed_ip":"",
"hash_password":null,
"allow_deeplink":0,
"hide_referer":0,
"start_at":"2017-06-17 12:35:00",
"stop_at":null,
"auto_offer_connect":null,
"required_approval":false,
"is_cpi":false,
"creatives":[],
"creatives_zip":null,
"smartlink_categories": ["595e3b5b7e28fede7b8b456d"],
"click_session":"1y",
"minimal_click_session":"0s",
"external_offer_id":"5a97f4af94b814997c8b456a",
"bundle_id":"5jfj7jjs0amcslsaaah",
"sub_restrictions": [
{
"sub1": "sub_value1",
"sub2": "sub_value2"
}
],
"caps_timezone": "Europe/Moscow",
"strictly_isp": [
"595e3b5b7e28fede7b8b456d"
],
"note_aff":"",
"note_sales":"",
"disallowed_ip":"",
"hide_caps":0,
"caps_status": [
"confirmed"
],
"caps_goal_overcap" : "install",
"commission_tiers" : [
{
"affiliate_type": "exact",
"affiliates": [
1
],
"goals": [],
"timeframe": "month",
"type": "budget",
"value": 55.6,
"target_goals": [],
"modifier_type": "to_percent",
"modifier_value": 10.02,
"modifier_payment_type": "payout",
"countries": []
}
],
"consider_personal_targeting_only": false,
"schedule": {
"enabled": true,
"date_start": "2022-01-09",
"date_to": "2022-08-01",
"timezone": "Europe\/Monaco",
"intervals": [
{
"day_of_week": 1,
"from": 2,
"to": 4
},
{
"day_of_week": 1,
"from": 8,
"to": 10
}
]
},
"duplicate_clicks_threshold": 0
}
}
Add new offer
Payment item structure
title - Payment title
partners ❋ - Array of partner ID, which include payments (It’s available only
for personal payments)
countries - An array of countries in ISO format (or put empty string to clear
existing items)
country_exclude - Exclude these countries. Available:0,1
cities - An array of id cities (or put empty string to clear existing items)
devices - The array of devices. Possible values: mediahub, mobile, ereader,
console, tv, tablet, desktop, smartwatch (or put empty string to clear existing
items)
os - Possible values (or put empty string to clear existing items)
goal - Value targets
total - The amount of payment
revenue - Payment webmaster
currency ❋ - Currency (Code in ECB format)
type ❋ - Type of payment
Possible values: fixed, percent, mixed, (cpc, cpm - optionally)
sub1 … subN - Comma-separated sub values. N is number in range 1..8. Example:
sub1=subVal1,subVal2
Landing structure
title ❋ - Title
url ❋ - Tracking URL
url_preview ❋ - View URL
type - Type
Possible values: landing, transit
By default: landing
Personal daily limit
partner - webmaster ID
caps - Daily limit
Strictly identify the operating system
os - String (OS). Possible values
versions - Array[string] OS versions with possible special chars >= or <.
Possible values When adding OS targeting to the API offer, the version is a
required parameter but can be an empty array value
Strictly identify ISP
country - String a country. ISO format
name - String a name. Possible values
Cap item structure
period - Possible values: hour (if enabled), day, month, all
type - Possible values: budget, conversions, clicks, impressions
value - The integer value for the type of conversion and the float value for the
budget type.
goals - Array[string]. Either specifies goal value or is empty. Empty field
requires “goal_type” values of “all”/“each”.
goal_type - [string]. Values: “all” , “each”, “exact”. “goals” field is
mandatory to be specified for “exact” value.
affiliates - Array[integer]. Either specifies affiliate ID or is empty filed.
Empty field requires “affiliate_type” values of “all”/“each”.
affiliate_type - [string]. Values: “all” , “each”, “exact”. “affiliates” field
is mandatory to be specified for “exact” value.
country - Array[string]. Values: Country codes.
country_type - [string]. Values: “all” , “each”, “exact”. “country” field is
mandatory to be specified for “exact” value.
sub_number - [integer]. Possible values: 2.
sub_value - Array[string]
Commission tier item structure
timeframe - Possible values: day, week, month, all
type - Possible values: budget, conversions
value - The integer value for the type of conversion and the float value for the
budget type.
modifier_value - The float value.
modifier_type - Possible values: by_fix, by_percent, to_fix, to_percent.
goals - Array[string]. Either specifies goal value or is empty.
target_goals - Array[string]. Either specifies target goal value or is empty.
affiliate_type - Possible values: all, each, exact. Default: each.
affiliates - Array[integer]. Either specifies affiliate ID or is empty filed.
modifier_payment_type - Possible values: payout, total, payout_and_total.
Default: payout.
countries - Array[string]. Countries ISO codes
conversion_status - Array[string]. Possible values: confirmed, pending,
declined, hold.
HTML creative item structure
name - Creative name
width - Creative width
height - Creative height
code - Creative html code with macroses
asset_mapping - How to map macros and asset. For example: {“aaa”:0}. Macros
{aaa} match to 0 asset
Offer schedule structure
enabled - Enable/Disable offer schedule. Possible values: 0,1
date_start - Date of launch, YYYY-MM-DD. Offer activation does not depend on
enabled field.
date_to - Date of deactivation, YYYY-MM-DD
timezone - Timezone. Example: Europe/London
intervals - Array of schedule intervals. Example:
[weekday_number(0-6)][interval_number(0,1,2,…)][from]=hour(0-23)
[weekday_number(0-6)][interval_number(0,1,2,…)][to]=hour(0-23)
curl sample:
curl --request POST --form 'schedule[enabled]=1' \ --form
'schedule[date_start]=2020-05-16' \ --form 'schedule[date_to]=2021-05-16' \
--form 'schedule[timezone]=Europe/London' \ --form
'schedule[intervals][0][0][From]=4' \ --form 'schedule[intervals][0][0][To]=9' \
--form 'schedule[intervals][0][1][From]=1' \ --form
'schedule[intervals][0][1][To]=2'
POST /3.0/admin/offer
Parameter Type Available & Default Description title String REQUIRED Title
advertiser String REQUIRED Advertiser ID url String REQUIRED Tracking URL
parallel_tracking_url String Parallel tracking URL cross_postback_url String
Cross-postback URL macro_url String Additional macro url_preview String View URL
trafficback_url String Trafficback URL description_lang Array[string] Offer
description on specified language. Example: description_lang[en] = ‘English
description’ stopDate String Available: YYYY-MM-DD Stop date creativeFiles
Array[string] Available: image/jpeg, image/png, image/gif, application/zip An
array of creative FILES to upload creativeUrls Array[string] An array of URLs to
external creative resources creativeDownloads Array[string] An array of URLs to
external creative resources for download creativesHtml Array[string] HTML
creative (See Structure) creativeAssets Array[file] Assets for html creative
creativeFileTitles Array[string] Array of titles for file creatives
creativeUrlTitles Array[string] Array of titles for url creatives
creativeDownloadTitles Array[string] Array of titles for download creatives
sources Array[string] An array of traffic sources The list of available sources
of traffic in the section logo FormData Available: image/jpeg, image/pjpeg,
image/png, image/gif logo File status String Default: stopped
Available: stopped, active, suspended Offer status tags Array[string] Offer tags
privacy String Available: public, protected, private Privacy level is_top
Integer Available: 0, 1 The top offer is_cpi Integer Available: 0, 1 CPI
payments Array[string] REQUIRED Payments array (See Structure) partner_payments
Array[string] An array of personal paymentsy (See Structure)
notice_percent_overcap Integer The percentage conversions to achieve the daily
limit at which the messages will be sent landings Array[string] An array of
landings(See Structure) strictly_country Integer Available: 0, 1 Strictly
identify the country strictly_connection_type String Available: “”, wi-fi,
cellular Strictly identify the connection type. Set a value to empty for
choosing the all strictly connection type. strictly_os Array[string] Deprecated
: use restriction_os restriction_os Array[string] Strictly identify the
operating system (See Structure) strictly_devices Array[string] Strictly
identify the device (See Possible values) caps Array[CapStructure] Caps (See
CapStructure) strictly_brands Array[string] Vendors (See Vendors) caps_status
Array[string] Array of conversion statuses for caps calculation. Available
values: “confirmed”, “pending”, “hold”, “declined”. Status “not_found” is
deprecated and will be transformed to “declined”. caps_timezone String Select
timezone of conversions calculating for caps with periods day/month
commission_tiers Array[CommissionTierStructure] Commission tiers (See
CommissionTierStructure). enabled_commission_tiers Integer Available: 0, 1
Default: 0 Enable commission tiers hold_period Integer Available: between 0 and
60 Hold time hold_type String Available: days, hours Default: days categories
Array[string] An array of categories notes String Offer notes allowed_ip String
Allowed IP. Example: 127.0.0.1\n127.0.1.1-127.0.2.1 hash_password String Secure
postback code allow_deeplink Integer Available: 0, 1 Allow diplinks hide_referer
Integer Available: 0, 1 Hide referrer redirect_type String http302,
http302hidden, js, meta Redirect types: http302 - usual http redirect with code
302. Without referrer passing: http302hidden, meta (meta-tag redirect), js
(javascript redirect) schedule[date_start] String Available: YYYY-MM-DD Date
time of launch is_redirect_overcap Integer Default: 0
Available: 0, 1 Send traffic to trafficback by daily overcaps. hide_payments
Integer Default: 0
Available: 0, 1 Hide the percentage of contributions to offer for partners if it
is the type of Percent payment. click_session String Default: 1y Click Session
Lifespan
Example: 1y2m3w4d5h6i7s
Scales must be one from: y(year), m(month), w(week), d(day), h(hour), i(minute),
s(second) minimal_click_session String Default: 0s Minimal click session
lifespan
Example: 1y2m3w4d5h6i7s
Scales must be one from: y(year), m(month), w(week), d(day), h(hour), i(minute),
s(second) sub_account_1 String Available only letters(a-z), numbers(0-9) and
these symbols: ,._-{}+=/:~ Allowed sub1 values sub_account_2 String Available
only letters(a-z), numbers(0-9) and these symbols: ,._-{}+=/:~ Allowed sub2
values sub_account_1_except Integer Default: 0
Available: 0, 1 Block sub1 values, set only with sub_account_1
sub_account_2_except Integer Default: 0
Available: 0, 1 Block sub2 values, set only with sub_account_2
smartlink_categories Array[string] Smartlink category ID. Use
/3.0/admin/smartlink/categories to get an ID. Use empty value to remove a
Smartlink category from an offer. kpi Array[string] KPI description on specified
language. Example: kpi[en] = ‘English text’ sub_restrictions Array[structure]
Sub restriction pair. Example or structure: sub_restrictions[0][sub1] =
‘sub1_val’, sub_restrictions[0][sub2] = ‘sub2_val’, sub_restrictions[1][sub1] =
‘sub2_val’, etc.. uniqIpOnly Integer Default: 0
Available: 0, 1 Unique IP only flag rejectNotUniqIp Integer Default: 0
Available: 0, 1 Reject not unique Ip flag strictly_isp Array[string] Deprecated
: use restriction_isp restriction_isp Array[string] Stricly ISP (See Structure)
external_offer_id String External offer id bundle_id String Bundle id note_aff
String Note for affiliate note_sales String Note for sales disallowed_ip String
disallowed ip hide_caps Integer Available: 0, 1 Hide caps in partner interface
search_empty_sub Integer Available: 1..8 Search for an empty sub with this
number caps_goal_overcap String Enabled - When cap for chosen default goal is
reached, clicks would be redirected to Trafficback url targeting
Array[TargetingGroupStructure] Array of targeting groups (See Structure)
allow_impressions Integer Available: 0, 1 Allow impressions for offer
impressions_url String Impressions destination URL
additional_impression_destination_urls String Additional impression destination
URL consider_personal_targeting_only String Available: true/false schedule
ScheduleStructure Offer schedule (See Structure) sign_clicks_integration String
Available: no_sign,appsflyer,kochava Click Signature Service tracking_domain
String The domain name (FQDN) for the tracking URL duplicate_clicks_threshold
Integer Default: 0
Available: 0..100 The number of clicks after which a user will be redirected to
Trafficback cross_postback_method String Available: get/post Cross-postback
method cross_postback_body String REQUIRED for cross_postback_method=post
Cross-postback body macros_replacement Array[structure] Available: sub1..sub8
Available if the Macros Replacement feature is enabled. Example of the
structure: macros_replacement[sub1][]=value macros_replacement_enabled
Array[string] Available: sub1..sub8 Available if the Macros Replacement feature
is enabled
Targeting group structure
JSON structure example
PHP example
Parameter Type Available & Default Description country[allow/deny] Array[string]
countries ISO codes list of allowed/denied countries. Example:
country[allow][]=US region[allow/deny][countryISO] Array[Integer] region codes
list of allowed/denied regions for chosen country(ISO). Example:
region[allow][US]=33 city[allow/deny][countryISO] Array[Integer] city codes list
of allowed/denied cities for chosen country(ISO). Example: city[allow][US]=57
os[allow] Array[Ostructure] list of allowed OSes and them versions. To deny
specific version should use according comparison operation. (See OS Structure)
isp[allow][countryISO] Array[String] ISP list list of allowed ISP for chosen
country(ISO). Example: isp[allow][US]=Att ip[allow/deny] Array[string] list of
allowed/denied ip ranges (IPv4 , IPv6). Available formats : “100.0.0.1” (single
IP), “100.0.0.1-100.0.0.255” (IP range), “222.1.1.20/26” (IP/mask) device_type
Array[string] “mobile”, “tablet”, “desktop”, “mediahub”, “ereader”, “console”,
“tv”, “smartwatch” list of allowed device types. browser[allow/deny]
Array[string] list of allowed/denied browsers. Example: browser[deny][] = “Edge”
brand[allow/deny] Array[string] list of allowed/denied device brands. Example:
brand[deny][] = “SAMTEL” sub[allow/deny][subNumber] Array[string] list of
allowed/denied subs for chosen sub parameter. Example:
sub[allow][2][]=“subValue” sub[deny_groups][groupNumber][subNumber] String list
of denied sub restricted groups (when is needed to block sub pairs(and more):
sub1=“A” + sub2=“B”). Example: sub[deny_groups][0][1]=“A” +
sub[deny_groups][0][2]=“B”. To implement “Block traffic if empty sub” option,
put empty string in the group : sub[deny_groups][1][8]=“” connection
Array[string] “wi-fi”, “cellular” list of allowed connection types. block_proxy
Integer 0, 1 enable/disable “Click-level Anti-fraud” feature affiliate_id
Array[Integer] list of affiliates for personal targeting groups. url String
Additional Tracking URL urls []UrlWeight URLs with weights for traffic
redistribution between several track-links zip[allow/deny] Array[string] list of
zip codes macros_replacement Array[structure] Available: sub1..sub8 Available if
the Macros Replacement feature is enabled. Example of the structure:
macros_replacement[sub1][]=value macros_replacement_enabled Array[string]
Available: sub1..sub8 Available if the Macros Replacement feature is enabled
UrlWeight structure
Parameter Type Available & Default Description url String Tracking URL. Example:
additional_impression_destination_urls[0][url]=example.com weight Integer 0-100
track-link weight. Example: additional_impression_destination_urls[0][weight]=50
OS structure
Parameter Type Available & Default Description name String OS name that could be
found at OSes list method. comparison String LT, LTE, EQ, GT, GTE Comparison
operation for OS version. version String OS version for comparision.
EDIT OFFER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "title=test_edit" http://YOUR_API_DOMAIN/3.0/admin/offer/936
> Response example:
{
"status":1,
"offer":{
"id":936,
"offer_id":"5943f7307e28fe9a1f8b456d",
"advertiser":"573c69a33b7d9b0e638b4576",
"hide_payments":false,
"title":"test_edit",
"macro_url":null,
"url":"http:\/\/YOUR_API_DOMAIN",
"parallel_tracking_url":"",
"cross_postback_url":"http:\/\/test-url.com",
"cross_postback_method": "get",
"cross_postback_body": "",
"url_preview":"http:\/\/preview.YOUR_API_DOMAIN",
"preview_url":"http:\/\/preview.YOUR_API_DOMAIN",
"domain_url":"YOUR_API_DOMAIN",
"use_https":false,
"use_http":true,
"description_lang": {
"ru" : "Описание",
"en" : "Description"
},
"sources":[
],
"logo":"\/images\/cpa\/logos\/",
"status":"stopped",
"tags":["default"],
"privacy":"public",
"is_top":0,
"payments":[
],
"partner_payments":[
],
"landings":[
],
"strictly_country":0,
"strictly_os":{},
"strictly_connection_type": "wi-fi",
"is_redirect_overcap":false,
"notice_percent_overcap":null,
"hold_period":0,
"hold_type_":"days",
"categories":[
],
"full_categories":[
],
"cr":0,
"epc":0,
"notes":null,
"allowed_ip":"",
"hash_password":null,
"allow_deeplink":0,
"hide_referer":0,
"start_at":"2017-06-17 12:35:00",
"stop_at":null,
"auto_offer_connect":null,
"required_approval":false,
"is_cpi":false,
"creatives":[],
"creatives_zip":null,
"smartlink_categories": ["595e3b5b7e28fede7b8b456d"],
"click_session":"1y",
"minimal_click_session":"0s",
"sub_restrictions": [
{
"sub1": "sub_value1",
"sub2": "sub_value2"
}
],
"caps_timezone": "Europe/Moscow",
"strictly_isp": [
"595e3b5b7e28fede7b8b456d"
],
"hide_caps":0,
"caps_status": [
"confirmed"
],
"caps_goal_overcap" : "install",
"commission_tiers" : [
{
"affiliate_type": "exact",
"affiliates": [
1
],
"goals": [],
"timeframe": "month",
"type": "budget",
"value": 55.6,
"target_goals": [],
"modifier_type": "to_percent",
"modifier_value": 10.02,
"modifier_payment_type": "payout",
"countries": []
}
],
"consider_personal_targeting_only" : false,
"schedule": {
"enabled": true,
"date_start": "2022-01-08",
"date_to": "2022-09-01",
"timezone": "Europe\/Monaco",
"intervals": [
{
"day_of_week": 1,
"from": 2,
"to": 4
},
{
"day_of_week": 1,
"from": 8,
"to": 10
}
]
},
"duplicate_clicks_threshold": 0
}
}
Change an offer settings
POST /3.0/admin/offer/{ID}
Parameter Type Available & Default Description title String Title advertiser
String Advertiser ID url String Tracking URL parallel_tracking_url String
Parallel tracking URL cross_postback_url String Cross-postback URL macro_url
String Additional macro url_preview String View URL trafficback_url String
Trafficback URL description_lang Array[string] Offer description on specified
language. Example: description_lang[en] = ‘English description’ kpi
Array[string] KPI description on specified language. Example: kpi[en] = ‘English
text’ stopDate String Available: YYYY-MM-DD Stop date creativeFiles
Array[string] Available: image/jpeg, image/png, image/gif, application/zip An
array of creative FILES to upload creativeUrls Array[string] An array of URLs to
external creative resources creativeDownloads Array[string] An array of URLs to
external creative resources for download creativesHtml Array[string] HTML
creative (See Structure) creativeAssets Array[file] Assets for html creative
creativeFileTitles Array[string] Array of titles for file creatives
creativeUrlTitles Array[string] Array of titles for url creatives
creativeDownloadTitles Array[string] Array of titles for download creatives
sources Array[string] An array of traffic sources The list of available sources
of traffic in the section logo FormData Available: image/jpeg, image/pjpeg,
image/png, image/gif logo File status String Default: stopped
Available: stopped, active, suspended Offer status tags Array[string] Offer tags
privacy String Available: public, protected, private Privacy level is_top
Integer Available: 0, 1 The top offer is_cpi Integer Available: 0, 1 CPI
payments Array[string] Payments array (See Structure) partner_payments
Array[string] An array of personal paymentsy (See add offer)
notice_percent_overcap Integer The percentage conversions to achieve the daily
limit at which the messages will be sent landings Array[string] An array of
landings(See Structure) strictly_country Integer Available: 0, 1 Strictly
identify the country strictly_connection_type String Available: “”, wi-fi,
cellular Strictly identify the connection type. Set a value to empty for
choosing the all strictly connection type. strictly_os Array[string] Deprecated
: use restriction_os restriction_os Array[string] Strictly identify the
operating system (See add offer) strictly_devices Array[string] Strictly
identify the device (See Possible values) caps Array[CapStructure] Caps (See
CapStructure) caps_status Array[string] Array of conversion statuses for caps
calculation. Available values: “confirmed”, “pending”, “hold”, “declined”.
Status “not_found” is deprecated and will be transformed to “declined”.
caps_timezone String Select timezone of conversions calculating for caps with
periods day/month commission_tiers Array[CommissionTierStructure] Commission
tiers (See CommissionTierStructure). Commission tier list replaces existing
list. To prevent a counter reset do not change fields in new list except value
and modifier_value. To delete commission tiers set empty field.
enabled_commission_tiers Integer Available: 0, 1 Default: 0 Enable commission
tiers hold_period Integer Available: between 0 and 60 Hold time hold_type String
Available: days, hours Default: days categories Array[string] An array of
categories notes String Offer notes allowed_ip String Allowed IP. Example:
127.0.0.1\n127.0.1.1-127.0.2.1 hash_password String Secure postback code
allow_deeplink Integer Available: 0, 1 Allow diplinks hide_referer Integer
Available: 0, 1 Hide referrer. Deprecated: use redirect_type redirect_type
String http302, http302hidden, js, meta Redirect types: http302 - usual http
redirect with code 302. Without referrer passing: http302hidden, meta (meta-tag
redirect), js (javascript redirect) schedule[date_start] String Available:
YYYY-MM-DD Date time of launch is_redirect_overcap Integer Default: 0
Available: 0, 1 Send traffic to trafficback by daily overcaps. hide_payments
Integer Default: 0
Available: 0, 1 Hide the percentage of contributions to offer for partners if it
is the type of Percent payment. click_session String Default: 1y Click Session
Lifespan
Example: 1y2m3w4d5h6i7s
Scales must be one from: y(year), m(month), w(week), d(day), h(hour), i(minute),
s(second) minimal_click_session String Default: 0s Minimal click session
lifespan
Example: 1y2m3w4d5h6i7s
Scales must be one from: y(year), m(month), w(week), d(day), h(hour), i(minute),
s(second) sub_account_1 String Sub1 list, separated by commas sub_account_2
String Sub2 list, separated by commas sub_account_1_except Integer Default: 0
Available: 0, 1 Except Sub1 list set only with sub_account_1
sub_account_2_except Integer Default: 0
Available: 0, 1 Except Sub2 list set only with sub_account_2
smartlink_categories Array[string] Smartlink category ID. Use
/3.0/admin/smartlink/categories to get an ID. Use empty value to remove a
Smartlink category from an offer. kpi Array[string] KPI description on specified
language. Example: kpi[en] = ‘English text’ sub_restrictions Array[structure]
Sub restriction pair. Example or structure: sub_restrictions[0][sub1] =
‘sub1_val’, sub_restrictions[0][sub2] = ‘sub2_val’, sub_restrictions[1][sub1] =
‘sub2_val’, etc.. uniqIpOnly Integer Default: 0
Available: 0, 1 Unique IP only flag rejectNotUniqIp Integer Default: 0
Available: 0, 1 Reject not unique Ip flag strictly_isp Array[string] Deprecated
: use restriction_isp restriction_isp Array[string] Stricly ISP (See Structure)
external_offer_id String External offer id bundle_id String Bundle id hide_caps
Integer Available: 0, 1 Hide caps in partner interface search_empty_sub Integer
Available: 1..8 Search for an empty sub with this number caps_goal_overcap
String Enabled - When cap for chosen default goal is reached, clicks would be
redirected to Trafficback url targeting Array[TargetingGroupStructure] Array of
targeting groups (See Structure) allow_impressions Integer Available: 0, 1 Allow
impressions for offer impressions_url String Impressions destination URL
additional_impression_destination_urls String Additional impression destination
URL consider_personal_targeting_only String Available: true/false schedule
ScheduleStructure Offer schedule (See Structure) sign_clicks_integration String
Available: no_sign,appsflyer,kochava Click Signature Service tracking_domain
String The domain name (FQDN) for the tracking URL duplicate_clicks_threshold
Integer Default: 0
Available: 0..100 The number of clicks after which a user will be redirected to
Trafficback cross_postback_method String Available: get/post Cross-postback
method cross_postback_body String REQUIRED for cross_postback_method=post
Cross-postback body
DELETE OFFER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "offer_id[0]=936" http://YOUR_API_DOMAIN/3.0/admin/offer/delete
> Response example:
{
"status":1,
"message":"Offer 936 is removed successfully."
}
Delete the offer
POST /3.0/admin/offer/delete
Parameter Type Available & Default Description offer_id Array[integer] REQUIRED
ENABLED/DISABLED AFFILIATES LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/offers/8935/privacy
> Response example:
{
"affiliates_disabled":
[],
"affiliates_enabled":
[
9
],
"privacy_level":"private"
}
Get list of enabled/disabled affiliates and offer’s privacy
GET /3.1/offers/{ID}/privacy
SOURCES
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/offer/sources
> Response example:
{
"status":1,
"sources":[
{
"id":"51f531f53b7d9b1e0382f6d9",
"title":"Web sites",
"title_lang":{"ru":"веб сайты","en":"web sites","es":""},
"allowed":0
}
]
}
Get list of sources
GET /3.0/admin/offer/sources
SOURCE ADD
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "title_lang[en]=api-test-en-3&title_lang[ru]=api-test-ru-3&title_lang[es]=api-test-es-2&title_lang[ka]=api-test-ka-2&title_lang[vi]=api-test-vi-3" http://YOUR_API_DOMAIN/3.0/admin/offer/source/
> Response example:
{
"status": 1,
"source": {
"title": "api-test-en-3",
"title_lang": {
"en": "api-test-en-3",
"ru": "api-test-ru-3",
"es": "api-test-es-2",
"ka": "api-test-ka-2",
"vi": "api-test-vi-3"
},
"id": "5b7e6d350f0e5a001c7bb4d5"
}
}
Get list of sources
POST /3.0/admin/offer/source
Parameter Type Available & Default Description title_lang Array[string]
Available: title_lang[ru], title_lang[en], title_lang[es], title_lang[ka],
title_lang[vi] REQUIRED Title different languages
SOURCE EDIT
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "title_lang[en]=api-test-en-3&title_lang[ru]=api-test-ru-3&title_lang[es]=api-test-es-2&title_lang[ka]=api-test-ka-2&title_lang[vi]=api-test-vi-3" http://YOUR_API_DOMAIN/3.0/admin/offer/source/5b7e6d350f0e5a001c7bb4d5
> Response example:
{
"status": 1,
"source": {
"title": "api-test-en-3",
"title_lang": {
"en": "api-test-en-3",
"ru": "api-test-ru-3",
"es": "api-test-es-2",
"ka": "api-test-ka-2",
"vi": "api-test-vi-3"
},
"id": "5b7e6d350f0e5a001c7bb4d5"
}
}
Get list of sources
POST /3.0/admin/offer/source/{ID}
Parameter Type Available & Default Description title_lang Array[string]
Available: title_lang[ru], title_lang[en], title_lang[es], title_lang[ka],
title_lang[vi] REQUIRED Title different languages
SOURCE REMOVE
curl -X DELETE --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/offer/source/5b7e6d350f0e5a001c7bb4d5
> Response example:
{
"status": 1,
"source": {
"title": "api-test-en-3",
"title_lang": {
"en": "api-test-en-3",
"ru": "api-test-ru-3",
"es": "api-test-es-2",
"ka": "api-test-ka-2",
"vi": "api-test-vi-3"
},
"id": "5b7e6d350f0e5a001c7bb4d5"
}
}
Get list of sources
DELETE /3.0/admin/offer/source/{ID}
CATEGORY ADD
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "title=test_category" http://YOUR_API_DOMAIN/3.0/admin/category
> Response example:
{
"status":1,
"category":{
"id":"59440f427e28feff5c8b4567",
"title":"test_category"
}
}
Add new category
POST /3.0/admin/category
Parameter Type Available & Default Description title String REQUIRED Category
title
CATEGORY EDIT
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "title=test_category2" http://YOUR_API_DOMAIN/3.0/admin/category/59440f427e28feff5c8b4567
> Response example:
{
"status":1,
"category":{
"id":"59440f427e28feff5c8b4567",
"title":"test_category2"
}
}
Change a category
POST /3.0/admin/category/{ID}
Parameter Type Available & Default Description title String REQUIRED Category
title
ENABLE AFFILIATE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "offer_id=935&pid=610¬ice=0" http://YOUR_API_DOMAIN/3.0/offer/enable-affiliate
> Response example:
{
"status":1,
"message":"Request for offer 935 is successfully"
}
Сonnection an affiliate to offer
POST /3.0/offer/enable-affiliate
Parameter Type Available & Default Description offer_id Mixed: Integer or
Array[integer] REQUIRED pid Integer REQUIRED Affiliate ID notice Integer
Default: 1
Available: 0 or 1 Send notice to affiliate
DISABLE AFFILIATE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "offer_id=935&pid=610¬ice=0" http://YOUR_API_DOMAIN/3.0/offer/disable-affiliate
> Response example:
{
"status":1,
"message":"Request for offer 935 is successfully"
}
Disconnect an affiliate from offer
POST /3.0/offer/disable-affiliate
Parameter Type Available & Default Description offer_id Mixed: Integer or
Array[integer] REQUIRED pid Integer REQUIRED Affiliate ID notice Integer
Default: 1
Available: 0 or 1 Send notice to affiliate
UPDATE OFFER`S STATUS
Update offers status
POST /3.0/admin/offer/mass-update
Parameter Type Available & Default Description offer_id Array[integer] REQUIRED
status String Available:
active
stopped
suspended Status privacy String Available:
public
protected
private Privacy level
POST /3.0/admin/offer/mass-update HTTP/1.1
Host: YOUR_API_DOMAIN
API-Key: d4735cd4fbf4ba08729cf3256c358ebefffb6f9d
Cache-Control: no-cache
Postman-Token: cefe4414-fc5b-1df0-5ef5-f788b8530f8f
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="offer_id[]"
2
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="offer_id[]"
1
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="status"
active
------WebKitFormBoundary7MA4YWxkTrZu0gW--
> Response example:
{
"status":1,
"message":"status updated"
}
DISABLE AFFILIATES
Disconnect all affiliates from private or protected offer
POST /3.0/admin/offer/{id}/disable-affiliates
Parameter Type Available & Default Description id Integer REQUIRED private or
protected offer ID
> Response example:
{
"status": 1,
"message": "Affiliates disabled successfully"
}
DISABLE OFFERS
Disconnect all private or protected offers from affiliate
POST /3.0/admin/affiliate/{id}/disable-offers
Parameter Type Available & Default Description id Integer REQUIRED affiliate ID
> Response example:
{
"status": 1,
"message": "Offers disabled successfully"
}
REMOVE CREATIVE FROM OFFER
Remove creative from offer by creative id
DELETE /3.0/admin/offer/{id}/remove-creative
Parameter Type Available & Default Description id Integer REQUIRED offer ID
creatives Array[integer] REQUIRED Creative IDs
> Response example:
{
"status": 1,
"removed": [
1,
2
]
}
CHANGE HTML CREATIVES
Change html creative from offer by creative id
POST /3.0/admin/offer/{offer_id}/creative/html/{creative_id}
Parameter Type Description code text REQUIRED HTML code name text REQUIRED
Creative name width int REQUIRED Creative width height int REQUIRED Creative
height
> Response example:
{
"creatives": [
{
"id": "7caf7245-be89-4845-bf47-31bfada8e3f9",
"type": "image/jpeg",
"url": "http://s3host/bucket/offers/99999/104/x-files.jpeg",
"title": "x-files",
"width": 1024,
"height": 768,
"size": 79685,
"overwritten": false
},
{
"id": "a899dae2-a9c0-4c11-a5d3-76a131a9ed0e",
"type": "text/html",
"url": "http://s3host/bucket/offers/99999/104/23249c03-a9b3-11ec-a56e-0242ac10ee4d.html",
"title": "html creative",
"width": 100,
"height": 100,
"size": 132,
"assets": [
{
"url": "http://s3host/bucket/99999/104/opt/app/web/creatives/ab/66/ab661c7ca92142727035b33a72a209d7.jpeg",
"title": "ab661c7ca92142727035b33a72a209d7.jpeg",
"size": 112836
}
],
"overwritten": false
}
]
}
DELETE HTML CREATIVES
Delete html creative from offer by creative id
DELETE /3.0/admin/offer/{offer_id}/creative/html/{creative_id}
> Response example:
{
"status": 1
}
LIST OF PROMOCODES
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "url=http://YOUR_API_DOMAIN&offer_id=906" http://YOUR_API_DOMAIN/3.1/offers/promocodes
> Response example:
{
"status": 1,
"data": {
"promocodes": [
{
"id": "63bbf54e8098683662ea61b5",
"type": "manual",
"code": "Black-1",
"code_template": "",
"description": "Some description",
"offer_id": 13,
"affiliate_id": 4,
"usage_limit": 100,
"usage_value": 0,
"date_from": "2023-01-09T00:00:00Z",
"date_to": "2023-01-29T00:00:00Z",
"created_at": "2023-01-09T11:06:54.189Z",
"updated_at": "2023-01-09T11:06:54.189Z"
}
],
"total_count": 2,
"per_page": 100,
"page": 1
}
}
List of promocodes
GET 3.1/offers/promocodes
Parameter Type Available & Default Description offer_id Integer Comma separated
list of identifiers affiliate_id Integer Comma separated list of identifiers
search String Search promocodes by part of string code String Search promocode
by exact match page Integer Default: 1 limit Integer Default: 100
PROMOCODES BULK CREATION
Available if the Promocode feature is enabled
POST /3.1/offers/promocodes/bulk
curl --location -X POST 'http://YOUR_API_DOMAIN/3.1/offers/promocodes/bulk' \
--header 'Api-key: {API-KEY}' \
--form 'promocodes[0][type]="manual"' \
--form 'promocodes[0][code]="qwerty"' \
--form 'promocodes[0][offer_id]="3"' \
--form 'promocodes[0][affiliate_id]="1"' \
--form 'promocodes[0][description]="some text"' \
--form 'promocodes[0][usage_limit]=1' \
--form 'promocodes[0][date_from]="2022-03-31T00:00:00Z"' \
--form 'promocodes[0][date_to]="2032-04-30T00:00:00Z"'
> Response example:
{
"status": 1,
"data": {
"promocodes": [
{
"id": "624ad87ac9c43aed7a32ef06",
"type": "manual",
"code": "qwerty",
"code_template": "",
"description": "some text",
"offer_id": 3,
"affiliate_id": 1,
"usage_limit": 1,
"usage_value": 0,
"date_from": "2022-03-31T00:00:00Z",
"date_to": "2032-04-30T00:00:00Z",
"created_at": "2022-04-04T11:37:30.137Z",
"updated_at": "2022-04-04T11:37:30.137Z"
}
]
}
}
Parameter Type Available & Default Description promocodes[0][type] String
Available: manual REQUIRED promocodes[0][code] String REQUIRED
promocodes[0][offer_id] Integer REQUIRED promocodes[0][affiliate_id] Integer
REQUIRED promocodes[0][description] String Max length: 130
promocodes[0][usage_limit] Integer promocodes[0][date_from] String REQUIRED
format RFC3339 promocodes[0][date_to] String REQUIRED
format RFC3339
AFFILIATE MANAGING (ADMIN METHODS)
GET AFFILIATE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/partner/{id}
> Response example:
{
"status": 1,
"partner": {
"id": 1,
"created_at": "2015-08-25 15:10:16",
"updated_at": "0000-00-00 00:00:00",
"email": "demo@demo.com",
"login": "demo@demo.com",
"contactPerson": "",
"ref_percent": null,
"name": "",
"notes": "",
"manager": null,
"status": "active",
"payment_systems": [],
"customFields": [],
"balance": {
"CNY": {
"balance": 0,
"hold": 0,
"available": 0
},
"USD": {
"balance": 0,
"hold": 0,
"available": 0
},
"EUR": {
"balance": 0,
"hold": 0,
"available": 0
}
},
"offersCount": 0,
"api_key": "39ab3b372f26e65f4caa4f36e953b912d460343b",
"address_1": null,
"address_2": null,
"city": null,
"country": null,
"zip_code": null,
"phone": null,
"tipalti_idap": null,
"ref": "0",
"enabledOffers": [],
"disabledOffers": [
{
"id": 1,
"title": "Offer1"
}
],
"enabledAdvertisers": [],
"disabledAdvertisers": [
{
"id": "647f4b830a518d29a2b90e08",
"title": "advert"
}
],
"enabledSmartlinks": [],
"disabledSmartlinks": [
{
"id": "6480edef003226b28340842f",
"name": "smart"
}
]
},
"id": 1
}
Get affiliate
GET /3.0/admin/partner/{id}
AFFILIATE LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/partners
> Response example:
{
"status":1,
"partners":[
{
"id":1,
"created_at":"2016-11-16 14:13:39",
"updated_at":"2016-11-16 14:13:39",
"email":"1111@qew.com",
"login":"default",
"contactPerson": "",
"ref_percent":null,
"name":"10",
"notes":"....",
"manager":null,
"status":"active",
"payment_systems":[
{
"id":10895,
"active":0,
"system":"Webmoney WMR",
"fields":{
"1":"..."
}
},
{
"id":10897,
"active":0,
"system":"Webmoney WMZ",
"fields":{
"1":"..."
}
}
],
"customFields":[
{
"name":"Skype",
"value":"1",
"label":"1",
"id":1
},
{
"name":"....",
"value":"2",
"label":"2",
"id":2
},
{
"name":"...",
"value":"3",
"label":"3",
"id":3
},
{
"name":"....",
"value":"4",
"label":"4",
"id":5
},
{
"name":"...",
"value":"5",
"label":"5",
"id":7
},
{
"name":"...",
"value":"6",
"label":"6",
"id":8
},
{
"name":"...",
"value":"1",
"label":"...",
"id":9
},
{
"name":"...",
"value":[
1
],
"label":{
"1":"..."
},
"id":10
},
{
"name":"...",
"value":[
2
],
"label":{
"2":"..."
},
"id":11
},
{
"name":"...",
"value":"7",
"label":"7",
"id":12
},
{
"name":"....",
"value":"8",
"label":"8",
"id":14
},
{
"name":"...",
"value":"9",
"label":"9",
"id":15
}
],
"balance":{
"USD":{
"balance":3418,
"hold":0,
"available":1050
},
"EUR":{
"balance":0,
"hold":0,
"available":0
}
},
"offersCount":46,
"api_key":"....",
"tags":[
]
}
],
"pagination":{
"per_page":1,
"total_count":9253,
"page":1,
"next_page":2
}
}
Get list of a partners
GET /3.0/admin/partners
Parameter Type Available & Default Description id Array[integer] Search by
affiliate IDs with_balance Integer Available: 1 Show partners with balance limit
Integer Default: 50
Available: max 500 Limit of entities page Integer Page of entities updated_at
String Get partners that have been updated from this date (format YYYY-MM-DD)
status String Available “active”, “banned”, “on moderation”, “not active” Filter
NEW AFFILIATE
curl -X POST \
http://YOUR_API_DOMAIN/3.0/admin/partner \
-H 'api-key: b12140975f18c5b088fd6e90ed5a4f26facbc117' \
-F password=qwerty123456 \
-F email=login@gmail.com \
-F login=ivan.ivanov \
-F ref_percent=2 \
-F notes=note \
-F status=active \
-F manager_id=5cd5530ad596c1c0008b4567 \
-F 'custom_fields[1]=skype' \
-F ref=2 \
-F sub_account_1=sub1 \
-F sub_account_2=sub2 \
-F sub_account_1_except=0 \
-F sub_account_2_except=1 \
-F 'payment_systems[0][fields][1]=BA731035962466786892' \
-F 'payment_systems[0][fields][2]=PK83DELLCTnbVB5RMU5TL1X4' \
-F 'payment_systems[0][currency]=USD' \
-F 'payment_systems[0][system_id]=1'
> Response example:
{
"status": 1,
"partner": {
"id": 5,
"created_at": "2019-07-16 16:55:45",
"updated_at": "2019-07-16 16:55:45",
"email": "login@gmail.com",
"login": "treva.jones",
"ref_percent": "2",
"name": null,
"notes": "note",
"manager": {
"api_key": "d6659d76dcce6857a118e2e9890518be",
"avatar": null,
"created_at": "2023-04-20 18:20:29",
"email": "new-user@gmail.com",
"facebook": "facebook",
"first_name": "John",
"id": "64414a2d9b70ab801d9b9a72",
"last_login_at": null,
"last_name": "Doe",
"roles": [
"ROLE_MANAGER_AFFILIATE"
],
"skype": "skype",
"telegram": "telegram",
"type": "affiliate_manager",
"updated_at": "2023-04-20 18:20:29",
"username": "64414a2d9b70ab801d9b9a72",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"work_hours": null
},
"status": "active",
"payment_systems": [
{
"id": 3,
"active": 0,
"system": "Webmoney",
"fields": {
"1": "BA731035962466786892",
"2": "PK83DELLCTnbVB5RMU5TL1X4"
}
}
],
"customFields": [
{
"name": "Skype",
"value": "skype",
"label": "skype",
"id": 1
}
],
"balance": {
"CNY": {
"balance": 0,
"hold": 0,
"available": 0
},
"USD": {
"balance": 0,
"hold": 0,
"available": 0
},
"EUR": {
"balance": 0,
"hold": 0,
"available": 0
},
"BTC": {
"balance": 0,
"hold": 0,
"available": 0
}
},
"offersCount": 0,
"api_key": "eff64a90010faabc92f845a7969a618986478993",
"address_1": null,
"address_2": null,
"city": null,
"country": null,
"zip_code": null,
"phone": null,
"ref": "2",
"sub_accounts": {
"1": {
"value": "sub1",
"except": 0
},
"2": {
"value": "sub2",
"except": 1
}
},
"contactPerson": null
},
"id": 5
}
Add new partner
Payment item structure
system_id - Integer ID of partners systems
currency - String the currency code.
fields - An array of Advanced fields. For example {‘Integer key’: ‘String
value’} where the key is ID from /3.0/admin/payment_systems and value it’s your
value of this field.
POST /3.0/admin/partner
Parameter Type Available & Default Description email String REQUIRED Partners
e-mail password String REQUIRED Partners password country String REQUIRED
Country ISO name login String Company name contact_person String Contact person
ref_percent String Percentage of referral program notes String Notes status
String Available: ‘not active’, ‘active’, ‘banned’, ‘on moderation’ Partners
status manager_id String Manager id payment_systems Array[string] An array of
payments (See Structure and /admin/payment_systems) custom_fields Array[string]
An array of custom fields (See /admin/custom_fields) ref Integer Referral
partner sub_account_1 String Sub1 list, separated by commas sub_account_2 String
Sub2 list, separated by commas sub_account_1_except Integer Default: 0
Available: 0, 1 Except Sub1 list sub_account_2_except Integer Default: 0
Available: 0, 1 Except Sub2 list notify Integer Default: 0
Available: 0, 1 Send welcome email to affiliate
login field should be set tipalti_payee_id Integer Tipalti Payee ID tags
Array[string] An array of affiliates’ tags enabledOffers Array[Integer] An array
of offer IDs disabledOffers Array[Integer] An array of offer IDs
enabledAdvertisers Array[string] An array of advertiser IDs disabledAdvertisers
Array[string] An array of advertiser IDs enabledSmartlinks Array[string] An
array of smartlink IDs disabledSmartlinks Array[string] An array of smartlink
IDs
EDIT AFFILIATE
curl -X POST \
http://YOUR_API_DOMAIN/3.0/admin/partner/5 \
-H 'api-key: b12140975f18c5b088fd6e90ed5a4f26facbc117' \
-F password=qwerty123456 \
-F email=login@gmail.com \
-F login=dima.ivanov \
-F ref_percent=2 \
-F notes=note \
-F status=active \
-F manager_id=5cd5530ad596c1c0008b4567 \
-F 'custom_fields[1]=skype' \
-F ref=2 \
-F sub_account_1=sub1 \
-F sub_account_2=sub2 \
-F sub_account_1_except=0 \
-F sub_account_2_except=1 \
-F 'payment_systems[0][fields][1]=BA731035962466786892' \
-F 'payment_systems[0][fields][2]=PK83DELLCTnbVB5RMU5TL1X4' \
-F 'payment_systems[0][currency]=USD' \
-F 'payment_systems[0][system_id]=1'
> Response example:
{
"status": 1,
"partner": {
"id": 5,
"created_at": "2019-07-16 16:55:45",
"updated_at": "2019-07-16 17:17:05",
"email": "login@gmail.com",
"login": "dima.ivanov",
"ref_percent": "2",
"name": null,
"notes": "note",
"manager": {
"api_key": "d6659d76dcce6857a118e2e9890518be",
"avatar": null,
"created_at": "2023-04-20 18:20:29",
"email": "new-user@gmail.com",
"facebook": "facebook",
"first_name": "John",
"id": "64414a2d9b70ab801d9b9a72",
"last_login_at": null,
"last_name": "Doe",
"roles": [
"ROLE_MANAGER_AFFILIATE"
],
"skype": "skype",
"telegram": "telegram",
"type": "affiliate_manager",
"updated_at": "2023-04-20 18:20:29",
"username": "64414a2d9b70ab801d9b9a72",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"work_hours": null
},
"status": "active",
"payment_systems": [
{
"id": 3,
"active": 0,
"system": "Webmoney",
"fields": {
"1": "BA731035962466786892",
"2": "PK83DELLCTnbVB5RMU5TL1X4"
}
},
{
"id": 4,
"active": 0,
"system": "Webmoney",
"fields": {
"1": "BA731035962466786892",
"2": "PK83DELLCTnbVB5RMU5TL1X4"
}
}
],
"customFields": [
{
"name": "Skype",
"value": "skype",
"label": "skype",
"id": 1
}
],
"balance": {
"USD": {
"balance": 0,
"hold": 0,
"available": 0
},
"EUR": {
"balance": 0,
"hold": 0,
"available": 0
},
"BTC": {
"balance": 0,
"hold": 0,
"available": 0
}
},
"offersCount": 0,
"api_key": "eff64a90010faabc92f845a7969a618986478993",
"address_1": null,
"address_2": null,
"city": null,
"country": null,
"zip_code": null,
"phone": null,
"ref": "2",
"sub_accounts": {
"1": {
"value": "sub1",
"except": 0
},
"2": {
"value": "sub2",
"except": 1
}
},
"contactPerson": null
},
"id": 5
}
Edit a partner
POST /3.0/admin/partner/{ID}
Parameter Type Available & Default Description password String Partners password
login String Company name country String Country ISO name contact_person String
Contact person ref_percent String Percentage of referral program notes String
Notes status String Available: “, ‘not active’, ‘active’, ‘banned’, ‘on
moderation’ Partners status manager_id String Manager id payment_systems
Array[string] An array of payments (See the add affiliate method and
/admin/payment_systems) custom_fields Array[string] An array of custom fields
(See /admin/custom_fields) ref Integer Referral partner sub_account_1 String
Sub1 list, separated by commas sub_account_2 String Sub2 list, separated by
commas sub_account_1_except Integer Default: 0
Available: 0, 1 Except Sub1 list sub_account_2_except Integer Default: 0
Available: 0, 1 Except Sub2 list tipalti_payee_id Integer Tipalti Payee ID tags
Array[string] An array of tags (Tags will be added to the existing)
enabledOffers Array[Integer] An array of offer IDs disabledOffers Array[Integer]
An array of offer IDs enabledAdvertisers Array[string] An array of advertiser
IDs disabledAdvertisers Array[string] An array of advertiser IDs
enabledSmartlinks Array[string] An array of smartlink IDs disabledSmartlinks
Array[string] An array of smartlink IDs
MASS UPDATE
curl -X POST 'http://YOUR_API_DOMAIN/3.0/admin/partners/mass-update' \
-H 'Api-Key: 6dc2ea20b5d12930268b8a2с' \
-F 'id[]=11' \
-F 'id[]=12' \
-F 'manager_id=5ce558efd596c1e4008b4569' \
-F 'status=on moderation'
> Response example:
{
"status": 1
}
Update status and manager
POST /3.0/admin/partners/mass-update
Parameter Type Available & Default Description id Array[integer] REQUIRED
Affiliate IDs manager_id String Manager ID status String Available: ‘not
active’, ‘active’, ‘banned’, ‘on moderation’ Status
CHANGE AFFILIATE PASSWORD
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/partner/password/10117
> Response example:
{
"status":1,
"partner":{
"id":10117,
"password":"5947c33371"
}
}
Change a partner’s password
POST /3.0/admin/partner/password/{ID}
ADD PARTNER POSTBACK
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "url=http://YOUR_API_DOMAIN&status=by_creating&offer_id=906&pid=610" http://YOUR_API_DOMAIN/3.0/partner/postback
> Response example:
{
"status":1,
"postback":{
"id":960,
"url":"http:\/\/YOUR_API_DOMAIN",
"status":"by_creating",
"goal":null,
"created":"2017-06-20 02:17:58",
"updated_at":"2017-06-20 02:17:58",
"forced":"0",
"pid":"1",
"integration_method":"all"
}
}
Add a partner’s postback
POST /3.0/partner/postback
Parameter Type Available & Default Description offer_id Integer Offer ID (missed
parameter means creation of global postback) url String REQUIRED Example:
http://YOUR_API_DOMAIN status String Available: by_creating, confirmed, pending,
declined, hold Postback status. Status "not_found” is deprecated and will be
transformed to “declined”. goal String Postback goal (value) pid Integer
REQUIRED integration_method String Default: all
Available: all, default, skad, probabilistic_attribution Postback integration
method.
EDIT PARTNER POSTBACK
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "url=http://YOUR_API_DOMAIN&status=confirmed&offer_id=906" http://YOUR_API_DOMAIN/3.0/partner/postback/960
> Response example:
{
"status":1,
"postback":{
"id":960,
"url":"http:\/\/YOUR_API_DOMAIN",
"status":"confirmed",
"goal":null,
"created":"2017-06-20 02:17:58",
"updated_at":"2017-06-20 02:17:58",
"forced":"0",
"pid": "1",
"integration_method": "all"
}
}
Edit a partner’s postback
POST /3.0/partner/postback/{ID}
Parameter Type Available & Default Description url String REQUIRED Example:
http://YOUR_API_DOMAIN status String Available: by_creating, confirmed, pending,
declined, hold Postback status. Status “not_found” is deprecated and will be
transformed to “declined”. goal String Postback goal (value) integration_method
String Available: all, default, skad, probabilistic_attribution Postback
integration method.
DELETE PARTNER POSTBACK
curl -X DELETE --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/partner/postback/960/remove
> Response example:
{
"status":1,
"postback":{
"id":960,
"url":"http:\/\/YOUR_API_DOMAIN",
"offer_id":"4",
"status":"confirmed",
"goal":null,
"created":"2017-06-20 02:17:58",
"updated_at":"2017-06-20 02:17:58",
"forced":"0",
"pid":"1",
"integration_method":"all"
}
}
Delete a partner’s postback
DELETE /3.0/partner/postback/{ID}/remove
DELETE PARTNERS POSTBACKS BY AFFILIATES IDS
curl -X DELETE --header "API-Key:{YOUR_API_KEY}" /
http://{YOUR_API_DOMAIN}/3.0/partner/postbacks/by-affiliates?ids=1,2,3
DELETE /3.0/partner/postbacks/by-affiliates
Parameter Type Available & Default Description ids comma separated array of
integers
DELETE PARTNERS POSTBACKS BY OFFERS IDS
curl -X DELETE --header "API-Key:{YOUR_API_KEY}" /
http://{YOUR_API_DOMAIN}/3.0/partner/postbacks/by-offers?ids=1,2,3
DELETE /3.0/partner/postbacks/by-offers
Parameter Type Available & Default Description ids comma separated array of
integers
AFFILIATE POSTBACKS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/postbacks
> Response example:
{
"status":1,
"postbacks":[
{
"id":8,
"url":"http://...",
"offer_id":null,
"status":"pending",
"goal":"",
"created":"2018-01-30 18:31:52",
"forced":"0",
"integration_method":"all"
},
{
"id":22,
"url":"http://...",
"offer_id":"17",
"status":null,
"goal":"",
"created":"2018-05-14 12:39:51",
"forced":"0",
"integration_method":"all"
},
{
"id":23,
"url":"http://...",
"offer_id":"17",
"status":"confirmed",
"goal":"1",
"created":"2018-05-14 12:41:00",
"forced":"0",
"integration_method":"all"
}
],
"pagination":{
"per_page":100,
"total_count":4,
"page":1
}
}
Get a list of partner postbacks
GET /3.0/admin/postbacks
Parameter Type Available & Default Description partner_id Integer REQUIRED limit
Integer Default: 100
Available: max 500 Limit of entities page Integer Page of entities
UPDATE PARTNER LOCALE
curl -X POST \
http://{YOUR_API_DOMAIN}}/3.0/admin/partner/{ID}/locale \
-H 'api-key: 5cfa769cfb2f6390f5519380' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F lang=en \
-F timezone=Europe/Minsk
> Response example:
{
"status": 1,
"message": "Updated successfully"
}
Update a partner’s locale
POST /3.0/admin/partner/{ID}/locale
Parameter Type Available & Default Description lang String Language timezone
String Timezone
GET REFERRALS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "" http://YOUR_API_DOMAIN/3.0/admin/partner/{ID}/referrals
> Response example:
{
"status": 1,
"referrals": {
"2": {
"id": 2,
"created_at": "2019-05-04 16:55:58",
"updated_at": "2019-05-04 16:57:32",
"email": "email@domain.aff",
"login": "login",
"ref_percent": null,
"name": null,
"notes": "Notes",
"manager": null,
"status": "active",
"level": 0,
"payment_systems": [
{
"id": 1,
"active": 0,
"system": "Webmoney",
"fields": {
"1": "11111",
"2": "22222"
}
}
],
"customFields": [
{
"name": "Skype",
"value": "skype",
"label": "skype",
"id": 1
}
],
"balance": {
"USD": {
"balance": 0,
"hold": 0,
"available": 0
},
"EUR": {
"balance": 0,
"hold": 0,
"available": 0
},
"BTC": {
"balance": 0,
"hold": 0,
"available": 0
}
},
"offersCount": 1,
"api_key": "api_key",
"address_1": "adress 1",
"address_2": "adress 2",
"city": "New York",
"country": "US",
"zip_code": "220089",
"phone": "375291111111",
"ref": "1",
"sub_accounts": {
"1": {
"value": "",
"except": 0
},
"2": {
"value": "",
"except": 0
}
}
}
},
"pagination": {
"per_page": 100,
"total_count": 1,
"page": 1
}
}
Get referrals by partner ID
GET /3.0/admin/partner/{id}/referrals
USER MANAGING (ADMIN METHODS)
USERS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/users
> Response example:
{
"status": 1,
"users": [
{
"id": "64413c649b70ab801d9b9a71",
"api_key": "c40469ac42533296ac6c638f392b2ece",
"avatar": null,
"created_at": "2023-04-20 17:21:40",
"email": "new-user@gmail.com",
"facebook": "facebook",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"skype": "skype",
"telegram": "telegram",
"first_name": "John",
"last_name": "Doe",
"last_login_at": null,
"roles": [
"ROLE_ADMIN"
],
"type": "common_manager",
"updated_at": "2023-04-20 17:21:40",
"username": "64413c649b70ab801d9b9a71",
"work_hours": null
}
],
"pagination": {
"per_page": 100,
"total_count": 18,
"page": 1
}
}
Get a list of users
GET /3.0/admin/users
Parameter Type Available & Default Description page Integer Page of entities
limit Integer Default: 100
Available: max 500 Limit of entities updated_at String Get users that have been
updated from this date (format YYYY-MM-DD) q String Search query
ADD USER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "email=user@YOUR_API_DOMAIN&password=123456&last_name=UserLastName&first_name=User&roles[]=ROLE_ADMIN" http://YOUR_API_DOMAIN/3.0/admin/user
> Response example:
{
"status": 1,
"user": {
"id": "64413c649b70ab801d9b9a71",
"api_key": "c40469ac42533296ac6c638f392b2ece",
"avatar": null,
"created_at": "2023-04-20 17:21:40",
"email": "new-user@gmail.com",
"facebook": "facebook",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"skype": "skype",
"telegram": "telegram",
"first_name": "John",
"last_name": "Doe",
"last_login_at": null,
"roles": [
"ROLE_ADMIN"
],
"type": "common_manager",
"updated_at": "2023-04-20 17:21:40",
"username": "64413c649b70ab801d9b9a71",
"work_hours": null
}
}
Add a new user
Roles list:
ROLE_ADMIN - Administrator
ROLE_MANAGER_AFFILIATE - Affiliate manager
ROLE_MANAGER_SALES - Sales manager
ROLE_SECTION_OFFER - Offer section
ROLE_SECTION_SUPPLIER - Supplier section
ROLE_SECTION_DASHBOARD - Dashboard section
ROLE_SECTION_NEWS - News section
ROLE_SECTION_CATEGORY - Category section
ROLE_SECTION_PARTNER - Affiliate section
ROLE_SECTION_TICKET - Ticket section
ROLE_SECTION_AUTOMATION - Automation
User types list
common_manager - Administrator
affiliate_manager - Affiliate manager
account_manager - Account manager
Roles help
If you select type common_manager roles field must contains ROLE_ADMIN
If you select type affiliate_manager roles field must contains
ROLE_MANAGER_AFFILIATE
If you select type account_manager roles field must contains ROLE_MANAGER_SALES
POST /3.0/admin/user
Parameter Type Available & Default Description email String REQUIRED Email
password String Available: 8 or up to 30 characters with at least one uppercase,
at least one lowercase, at least one numeric digit, at least one of the allowed
special characters listed: _-!@*.$%?&#/|\~<>^{}[]():; REQUIRED Password
first_name String REQUIRED Name last_name String REQUIRED Last name roles
Array[string] REQUIRED Array off allowed roles. See roles type String User type.
See user types skype String Skype whatsapp String Whatsapp telegram String
Telegram viber String Viber facebook String Facebook wechat String Wechat
work_hours String Working time avatar String:base64 Base64 encoded image.
Allowed formats: jpg, jpeg
EDIT USER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "email=user2@YOUR_API_DOMAIN&password=123456&last_name=UserLastName2&first_name=User2&roles[]=ROLE_ADMIN" http://YOUR_API_DOMAIN/3.0/admin/user/594927bd7e28fe1c4a8b4569
> Response example:
{
"status": 1,
"user": {
"id": "64413c649b70ab801d9b9a71",
"api_key": "c40469ac42533296ac6c638f392b2ece",
"avatar": null,
"created_at": "2023-04-20 17:21:40",
"email": "new-user@gmail.com",
"facebook": "facebook",
"viber": "viber",
"wechat": "wechat",
"whatsapp": "whatsapp",
"skype": "skype",
"telegram": "telegram",
"first_name": "John",
"last_name": "Doe",
"last_login_at": null,
"roles": [
"ROLE_ADMIN"
],
"type": "common_manager",
"updated_at": "2023-04-20 17:21:40",
"username": "64413c649b70ab801d9b9a71",
"work_hours": null
}
}
Change the user
User types list
common_manager - Administrator
affiliate_manager - Affiliate manager
account_manager - Account manager
Roles help
If you select type common_manager roles field must contains ROLE_ADMIN
If you select type affiliate_manager roles field must contains
ROLE_MANAGER_AFFILIATE
If you select type account_manager roles field must contains ROLE_MANAGER_SALES
POST /3.0/admin/user/{ID}
Parameter Type Available & Default Description email String Email password
String Available: 8 or up to 30 characters with at least one uppercase, at least
one lowercase, at least one numeric digit, at least one of the allowed special
characters listed: _-!@*.$%?&#/|\~<>^{}[]():; Password first_name String Name
last_name String Last name roles Array[string] Array off allowed roles. See
roles skype String Skype whatsapp String Whatsapp telegram String Telegram viber
String Viber facebook String Facebook wechat String Wechat work_hours String
Working time type String User type. See user types avatar String:base64 Base64
encoded image. Allowed formats: jpg, jpeg
CHANGE USER API KEY
Change user api key
POST /3.0/admin/user/api_key/{ID}
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "http://YOUR_API_DOMAIN/3.0/admin/user/api_key/594927bd7e28fe1c4a8b4569"
> Response example:
{
"status":1,
"user":{
"id":"594927bd7e28fe1c4a8b4569",
"api_key":"c740955e768795098c8b91ef40ec008526f3f884"
}
}
CHANGE USER PASSWORD
Change user password
POST /3.0/admin/user/{ID}/password
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "http://YOUR_API_DOMAIN/3.0/admin/user/594927bd7e28fe1c4a8b4569/password"
Parameter Type Available & Default Description password String Available: 8 or
up to 30 characters with at least one uppercase, at least one lowercase, at
least one numeric digit, at least one of the allowed special characters listed:
_-!@*.$%?&#/|\~<>^{}[]():; REQUIRED Password
> Response example:
{
"status":1,
"user":{
"id":"594927bd7e28fe1c4a8b4569",
"password":"c740955e768795098c8b91ef40ec008526f3f884"
}
}
UPDATE USER PERMISSIONS
Update user permissions
POST /3.1/user/{ID}/permissions
curl -X POST \
'http://YOUR_API_DOMAIN/3.1/user/{ID}/permissions' \
-H 'Content-Type: application/json' \
-H 'api-key: {API-kEY}' \
-d '{
"permissions": {
"automation": {
"affise-checker": {
"level": "deny"
}
},
"general": {
"marketplace": {
"level": "read"
},
"settings": {
"level": "deny"
},
"billing": {
"level": "write"
}
},
"notificator": {
"client-subscription": {
"level": "write"
},
"transport-configuration": {
"level": "write"
},
"user-subscription": {
"level": "write"
}
},
"stats": {
"affiliate-postback": {
"level": "read"
},
"clicks-list": {
"level": "read"
},
"comparison-report": {
"level": "read"
},
"conversions-export": {
"level": "read"
},
"conversions-import": {
"level": "write"
},
"conversions-list": {
"level": "read"
},
"entity-account-manager": {
"level": "read",
"default_level": "read",
"exceptions": {
"strings": {}
}
},
"entity-affiliate-manager": {
"level": "deny",
"exceptions": {
"strings": {}
}
},
"referral": {
"level": "deny"
},
"server-postback": {
"level": "read"
},
"slice-account_manager_id": {
"level": "deny"
},
"slice-advertiser_id": {
"level": "deny"
},
"slice-affiliate_id": {
"level": "read"
},
"slice-affiliate_manager_id": {
"level": "deny"
},
"slice-browser": {
"level": "deny"
},
"slice-city": {
"level": "read"
},
"slice-connection-type": {
"level": "deny"
},
"slice-country": {
"level": "read"
},
"slice-day": {
"level": "read"
},
"slice-device": {
"level": "read"
},
"slice-goal": {
"level": "read"
},
"slice-landing": {
"level": "deny"
},
"slice-mobile-carrier": {
"level": "deny"
},
"slice-offer_id": {
"level": "read"
},
"slice-os": {
"level": "read"
},
"slice-prelanding": {
"level": "deny"
},
"slice-smart_id": {
"level": "deny"
},
"slice-sub1": {
"level": "deny"
},
"slice-sub2": {
"level": "deny"
},
"slice-trafficback_reason": {
"level": "read"
},
"stats-export": {
"level": "read"
},
"view-custom": {
"level": "read"
},
"view-kpi": {
"level": "deny"
},
"view-retention-rate": {
"level": "deny"
},
"slice-events": {
"level": "read"
}
},
"users": {
"entity-account-manager": {
"level": "deny",
"exceptions": {
"strings": {}
}
},
"entity-advertiser": {
"level": "deny",
"exceptions": {
"strings": {}
}
},
"entity-affiliate": {
"level": "deny",
"exceptions": {
"ints": {}
}
},
"entity-affiliate-manager": {
"level": "write",
"exceptions": {
"strings": {}
}
},
"entity-common-manager": {
"level": "deny",
"exceptions": {
"strings": {}
}
},
"entity-preset": {
"level": "deny"
},
"view-users": {
"level": "deny"
}
}
}
}'
> Response example:
{
"status": 1,
"user": {
"id": "5f515aefa1ceda82eed06518",
"email": "test1@example.com",
"type": "affiliate_manager",
"first_name": "test1",
"last_name": "test1",
"permissions": {
"automation": {
"affise-checker": {
"level": "deny"
}
},
"general": {
"marketplace": {
"level": "read"
},
"settings": {
"level": "deny"
},
"billing": {
"level": "write"
}
},
"notificator": {
"client-subscription": {
"level": "write"
},
"transport-configuration": {
"level": "write"
},
"user-subscription": {
"level": "write"
}
},
"stats": {
"affiliate-postback": {
"level": "read"
},
"clicks-list": {
"level": "read"
},
"comparison-report": {
"level": "read"
},
"conversions-export": {
"level": "read"
},
"conversions-import": {
"level": "write"
},
"conversions-list": {
"level": "read"
},
"entity-account-manager": {
"level": "read",
"default_level": "read",
"exceptions": {
"strings": []
}
},
"entity-affiliate-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"referral": {
"level": "deny"
},
"server-postback": {
"level": "read"
},
"slice-account_manager_id": {
"level": "deny"
},
"slice-advertiser_id": {
"level": "deny"
},
"slice-affiliate_id": {
"level": "read"
},
"slice-affiliate_manager_id": {
"level": "deny"
},
"slice-browser": {
"level": "deny"
},
"slice-city": {
"level": "read"
},
"slice-connection-type": {
"level": "deny"
},
"slice-country": {
"level": "read"
},
"slice-day": {
"level": "read"
},
"slice-device": {
"level": "read"
},
"slice-goal": {
"level": "read"
},
"slice-landing": {
"level": "deny"
},
"slice-mobile-carrier": {
"level": "deny"
},
"slice-offer_id": {
"level": "read"
},
"slice-os": {
"level": "read"
},
"slice-prelanding": {
"level": "deny"
},
"slice-smart_id": {
"level": "deny"
},
"slice-sub1": {
"level": "deny"
},
"slice-sub2": {
"level": "deny"
},
"slice-trafficback_reason": {
"level": "read"
},
"stats-export": {
"level": "read"
},
"view-custom": {
"level": "read"
},
"view-kpi": {
"level": "deny"
},
"view-retention-rate": {
"level": "deny"
},
"slice-events": {
"level": "read"
}
},
"users": {
"entity-account-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-advertiser": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-affiliate": {
"level": "deny",
"exceptions": {
"ints": []
}
},
"entity-affiliate-manager": {
"level": "write",
"exceptions": {
"strings": []
}
},
"entity-common-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-preset": {
"level": "deny"
},
"view-users": {
"level": "deny"
}
}
},
"work_hours": "",
"api_key": "c03d492dc29faa4028610aaca57f00d1",
"created_at": "2020-09-03T21:06:55Z",
"updated_at": "2020-09-03T23:30:34Z"
}
}
READ USER
GET /3.0/admin/user/{ID}
Read single user
curl -X GET \
-H 'API-Key:23df424b0a53b0899f78685966243ee61'}
--data "http://YOUR_API_DOMAIN/3.0/admin/user/594927bd7e28fe1c4a8b4569"'
> Response example:
{
"status": 1,
"user": {
"id": "5f515aefa1ceda82eed06518",
"first_name": "test1",
"last_name": "test1",
"work_hours": "",
"email": "test1@example.com",
"skype": "test1",
"api_key": "c03d492dc29faa4028610aaca57f00d1",
"roles": [
"ROLE_MANAGER_AFFILIATE"
],
"updated_at": "2020-09-03T23:30:34Z",
"created_at": "2020-09-03T21:06:55Z",
"last_login_at": null,
"type": "affiliate_manager",
"avatar": null,
"info": null,
"permissions": {
"automation": {
"affise-checker": {
"level": "deny"
}
},
"general": {
"marketplace": {
"level": "read"
},
"settings": {
"level": "deny"
},
"billing": {
"level": "deny"
}
},
"notificator": {
"client-subscription": {
"level": "write"
},
"transport-configuration": {
"level": "write"
},
"user-subscription": {
"level": "write"
}
},
"stats": {
"affiliate-postback": {
"level": "read"
},
"clicks-list": {
"level": "read"
},
"comparison-report": {
"level": "read"
},
"conversions-export": {
"level": "read"
},
"conversions-import": {
"level": "write"
},
"conversions-list": {
"level": "read"
},
"entity-account-manager": {
"level": "read",
"default_level": "read",
"exceptions": {
"strings": []
}
},
"entity-affiliate-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"referral": {
"level": "deny"
},
"server-postback": {
"level": "read"
},
"slice-account_manager_id": {
"level": "deny"
},
"slice-advertiser_id": {
"level": "deny"
},
"slice-affiliate_id": {
"level": "read"
},
"slice-affiliate_manager_id": {
"level": "deny"
},
"slice-browser": {
"level": "deny"
},
"slice-city": {
"level": "read"
},
"slice-connection-type": {
"level": "deny"
},
"slice-country": {
"level": "read"
},
"slice-day": {
"level": "read"
},
"slice-device": {
"level": "read"
},
"slice-goal": {
"level": "read"
},
"slice-landing": {
"level": "deny"
},
"slice-mobile-carrier": {
"level": "deny"
},
"slice-offer_id": {
"level": "read"
},
"slice-os": {
"level": "read"
},
"slice-prelanding": {
"level": "deny"
},
"slice-smart_id": {
"level": "deny"
},
"slice-sub1": {
"level": "deny"
},
"slice-sub2": {
"level": "deny"
},
"slice-trafficback_reason": {
"level": "read"
},
"stats-export": {
"level": "read"
},
"view-custom": {
"level": "read"
},
"view-kpi": {
"level": "deny"
},
"view-retention-rate": {
"level": "deny"
},
"slice-events": {
"level": "read"
}
},
"users": {
"entity-account-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-advertiser": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-affiliate": {
"level": "deny",
"exceptions": {
"ints": []
}
},
"entity-affiliate-manager": {
"level": "write",
"exceptions": {
"strings": []
}
},
"entity-common-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-preset": {
"level": "deny"
},
"view-users": {
"level": "deny"
}
}
}
}
}
PUBLIC AUTH
Get user api key by login and password
POST /3.1/pub-auth
curl "https://YOUR_API_DOMAIN/3.1/pub-auth" \
--data "email=test@test.test" \
--data "password=PassworD"
Parameter Type Available & Default Description email String Available: a valid
email REQUIRED Email password String Available: 8 or up to 30 characters with at
least one uppercase, at least one lowercase, at least one numeric digit, at
least one of the allowed special characters listed: _-!@*.$%?&#/|\~<>^{}[]():;
REQUIRED Password
> Response example:
{
"status": 1,
"api_key": "c740955e768795098c8b91ef40ec008526f3f884"
}
CONVERSIONS MANAGING
EDIT CONVERSION
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "ids[0]=59359e1d7e28feb7568b456a&status=confirmed" http://YOUR_API_DOMAIN/3.0/admin/conversion/edit
> Response example:
{
"status":1,
"data":{
"ids":[
"59359e1d7e28feb7568b456a"
],
"status":"confirmed",
"currency":null,
"payouts":null,
"revenue":null
},
"message":"Conversion changes will take a few minutes"
}
Edit a conversion
POST /3.0/admin/conversion/edit
Parameter Type Available & Default Description ids Array[string] REQUIRED status
String Available: confirmed, pending, declined, hold currency String Example:
usd payouts Integer revenue Integer comment String Text a comment
IMPORT SINGLE CONVERSION
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "offer=1000&pid=500" http://YOUR_API_DOMAIN/3.0/admin/conversion/import
> Response example:
{
"status": 1,
"data": {
"offer": 1000,
"pid": 500,
"action_id": null,
"goal": null,
"ip": null,
"ua": null,
"sum": null,
"comment": null
},
"message": "Conversion import will take a few minutes"
}
Import a single conversion
POST /3.0/admin/conversion/import
Parameter Type Available & Default Description offer Integer REQUIRED Offer id
pid Integer REQUIRED Partner id action_id String advertiser conversion id
click_id String Click ID goal Integer goal number ip String visitor ip ua String
visitor user-agent comment String comment sum Integer payouts amount for
conversion (for percent payment type only) status String Available: confirmed,
pending, declined, hold custom_field_1 String custom field 1 custom_field_2
String custom field 2 custom_field_3 String custom field 3 custom_field_4 String
custom field 4 custom_field_5 String custom field 5 custom_field_6 String custom
field 6 custom_field_7 String custom field 7 created_at String Available:
YYYY-MM-DD not later than 2 month from Default: now Created at
send_affiliate_postbacks Bool Available: 1, 0
Default: 0 If 1 conversion affiliate postback will be send
IMPORT MULTIPLE CONVERSIONS
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "list[0][offer]=1000&list[0][pid]=500" http://YOUR_API_DOMAIN/3.0/admin/conversions/import
> Response example:
{
"status": 1,
"data": {
"list": [
{
"offer": 1000,
"pid": 500,
"action_id": null,
"goal": null,
"ip": null,
"ua": null,
"sum": null,
"comment": null
}
]
},
"message": "Conversion import will take a few minutes"
}
Import multiple conversions
POST /3.0/admin/conversions/import
Parameter Type Available & Default Description list[0][offer] Integer REQUIRED
Offer id list[0][pid] Integer REQUIRED Partner id list[0][action_id] String
advertiser conversion id list[0][click_id] String Click ID list[0][goal] Integer
goal number list[0][ip] String visitor ip list[0][ua] String visitor user-agent
list[0][comment] String comment list[0][sum] Integer payouts amount for
conversion (for percent payment type only) list[0][status] String Available:
confirmed, pending, declined, hold, pending_cap list[0][custom_field_1] String
custom field 1 list[0][custom_field_2] String custom field 2
list[0][custom_field_3] String custom field 3 list[0][custom_field_4] String
custom field 4 list[0][custom_field_5] String custom field 5
list[0][custom_field_6] String custom field 6 list[0][custom_field_7] String
custom field 7 list[0][created_at] String Available: YYYY-MM-DD not later than 2
month from Default: now Created at send_affiliate_postbacks Integer Available:
1, 0
Default: 0 If 1 conversion affiliate postback will be send
OTHER MANAGING (ADMIN METHODS)
CITY LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/cities
> Response example:
{
"cities":[
{
"country_code": "DE",
"id": 79729,
"name": "Thallichtenberg",
"region_code": "Rheinland-Pfalz"
},
{
"country_code": "DE",
"id": 40034,
"name": "Sindelfingen",
"region_code": "Baden-Wurttemberg"
},
{
"country_code": "DE",
"id": 75980,
"name": "Hofkirchen",
"region_code": "Bayern"
}
],
"pagination":{
"page":1,
"per_page":2147483647,
"total_count":3
},
"status":1
}
Get city list
GET /3.1/cities
Parameter Type Available & Default Description country Comma Separated Array of
string REQUIRED Country code. Example : US q String Search query code Comma
Separated Array of integer City codes for filter
DEVICES LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/devices
> Response example:
{
"status":1,
"types":[
"mediahub",
"mobile",
"ereader",
"console",
"tv",
"tablet",
"desktop",
"smartwatch"
]
}
Get list of devices
GET /3.1/devices
BROWSERS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/browsers
> Response example:
{
"browsers":[
"Yahoo Mobile Messenger for Android",
"Dillo",
"lolifox",
"Facebook for Windows",
"Web Light",
"CometBird",
"MetaCert Safe iPad Browser"
],
"pagination":{
"page":1,
"per_page":2147483647,
"total_count":527
},
"status":1
}
Get browsers list
GET /3.1/browsers
CURRENCY LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/admin/currency
> Response examples:
{
"status":1,
"quotes":{
"RUB":59.312599,
"USD":1,
"AED":3.672497,
"AFN":66.669998,
"ALL":125.800003,
"AMD":485.299988,
"ANG":1.769851,
"AOA":165.080994
}
}
GET /3.0/admin/currency?extended=1
{
"status": 1,
"quotes": [
{
"_id": 2,
"code": "USD",
"active": true,
"default": true,
"rate": 1,
"min_payment": 20,
"is_crypto": null
}
]
}
Get list of currency
GET /3.0/admin/currency
Parameter Type Available & Default Description get_only_active integer Default:
0
Available: 1 Ignore inactive currencies extended integer Default: 0
Available: 1 Extended currencies information
PAYMENT SYSTEMS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/payment_systems
> Response example:
{
"status":1,
"payment_systems":[
{
"id":2,
"lang_label":"Wire transfer",
"fields":[
{
"id":1,
"lang_label":"IBAN\/Account Number",
"required":true
},
{
"id":2,
"lang_label":"Swift\/BIC-Code",
"required":true
},
{
"id":3,
"lang_label":"Bank name",
"required":true
},
{
"id":4,
"lang_label":"Bank address",
"required":true
}
],
"currency":null
},
{
"id":3,
"lang_label":"Webmoney WMZ",
"fields":[
{
"id":1,
"lang_label":"WMZ",
"required":true
}
],
"currency":"AED"
}
]
}
Get list of payment systems
GET /3.0/admin/payment_systems
CUSTOM FIELDS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/custom_fields
> Response example:
{
"status":1,
"fields":[
{
"id":1,
"name":"Skype",
"required":false,
"field_type":"text",
"field_values":null
}
]
}
Get list of signup settings
GET /3.0/admin/custom_fields
DOMAINS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/domains
> Response example:
{
"status":1,
"domains":[
{
"url":"domain1.com",
"use_https": false
},
{
"url":"domain2.com",
"use_https": false
}
]
}
Get domains
GET /3.0/admin/domains
GET TICKET
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/ticket/{id}
> Response example:
{
"status": 1,
"ticket": {
"id": "1",
"status": "closed",
"type": "common",
"title": "Connect offer",
"description": "I want to connect offer",
"partner": {
"id": 3,
"created_at": "2018-06-20 14:42:40",
"updated_at": "2018-06-20 14:42:40",
"email": "testtest@gmail.com",
"login": "testtest@gmail.com",
"ref_percent": null,
"name": "",
"notes": "",
"manager": null,
"status": "not active",
"level": 0,
"payment_systems": [],
"customFields": [],
"balance": {
"USD": {
"balance": 0,
"hold": 0,
"available": 0
}
},
"offersCount": 0,
"api_key": "742638e984afa1dc12983966b4d424228b483b30",
"address_1": null,
"address_2": null,
"city": null,
"country": null,
"zip_code": null,
"phone": null,
"ref": null
},
"offer": {
"id": 9,
"offer_id": "5b2ba4beb861fd58ad8b4670",
"title": "Offer",
"preview_url": "http://link.preview.com",
"description": "",
"cr": 7,
"epc": 0,
"logo": "",
"logo_source": null,
"stop_at": null,
"sources": [],
"categories": [],
"full_categories": [],
"countries": null,
"payments": [
{
"countries": [],
"cities": [],
"country_exclude": false,
"title": "RevShare",
"goal": "1",
"currency": "USD",
"type": "percent",
"devices": [],
"os": []
},
{
"countries": [],
"cities": [],
"country_exclude": false,
"title": "Deposit",
"goal": "3",
"revenue": 0,
"currency": "USD",
"type": "fixed",
"devices": [],
"os": []
}
],
"goals": {
"1": "RevShare",
"2": "RevShare",
"3": "Deposit",
"4": "Registration"
},
"caps": [],
"caps_timezone": "Europe/Moscow",
"cap": 0,
"hide_caps": 0,
"required_approval": false,
"strictly_country": 1,
"strictly_os": [],
"strictly_brands": null,
"is_cpi": false,
"kpi": {
"en": ""
},
"creatives": [],
"creatives_zip": null,
"landings": [],
"links": [],
"macro_url": "",
"link": null,
"use_https": false,
"use_http": true,
"hold_period": 0,
"hold_type": "days",
"click_session": "1y",
"disabled_choice_postback_status": false,
"strictly_isp": [],
"restriction_isp": [],
"impressions_link": null
},
"attachments": [
"http:\/\/YOUR_API_DOMAIN\/3.0\/admin\/ticket\/file\/23\/faafe9b1df79e05f4eaf8e6516d7bfafbde2e1f4.png"
],
"created": "2018-09-12 12:05:18",
"updated": null
},
"id": "1"
}
Get ticket
GET /3.0/admin/ticket/{id}
TICKET LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/tickets
> Response example:
{
"status":1,
"tickets":[
{
"id":"17340",
"status":"open",
"type":"common",
"title":"...",
"description":"...",
"partner":{
"id":9310,
"updated_at":"2016-03-01 14:07:29",
"email":"...@...",
"login":"...@...",
"ref_percent":null,
"name":"",
"notes":"...",
"manager":null,
"status":"active",
"level":0,
"payment_systems":[
{
"id":10811,
"active":0,
"system":"Webmoney WMZ",
"fields":{
"1":"...."
}
},
{
"id":10812,
"active":0,
"system":"Webmoney WMR",
"fields":{
"1":"...."
}
}
],
"customFields":[
{
"name":"Skype",
"value":"...",
"label":"...",
"id":1
}
],
"balance":{
"USD":{
"balance":14,
"hold":0,
"available":14
}
},
"offersCount":3,
"api_key":"5099412c192828adfe79892d25e5e4a41ffb"
},
"offer":{
"id":718,
"offer_id":"563785d13b7d9bc31b8b4585",
"title":"...",
"preview_url":"https:\/\/YOUR_API_DOMAIN\/",
"description":"...",
"cr":0.63,
"epc":0.03,
"logo":"http:\/\/YOUR_API_DOMAIN\/images\/cpa\/logos\/292223717.png",
"stop_at":null,
"sources":[
{
"id":"51f531f53b7d9b1e0382f6d9",
"title":"Web sites",
"allowed":1
}
],
"categories":[
"..."
],
"full_categories":[
{
"id":"5368afb23b7d9b4d5d505342",
"title":"..."
}
],
"countries":[
"us"
],
"payments":[
{
"countries":[
"US"
],
"cities":[
],
"country_exclude":false,
"title":"",
"goal":1,
"revenue":7,
"currency":null,
"type":"fixed",
"devices":[
],
"os":[
]
}
],
"goals":{
"1":""
},
"required_approval":true,
"landings":[
{
"id":1446479313,
"title":"...",
"url":"http:\/\/YOUR_API_DOMAIN\/landingpages\/1811\/index.php\u0026click_id={clickid}",
"url_preview":"http:\/\/YOUR_API_DOMAIN\/landingpages\/1880\/index.php",
"type":"landing"
}
],
"is_cpi":false,
"creatives":[
],
"creatives_zip":null,
"links":[
],
"macro_url":null,
"link":null,
"use_https":false,
"use_http":true,
"hold_period":21,
"hold_type": "days",
"click_session":null
},
"attachments": [
"http:\/\/YOUR_API_DOMAIN\/3.0\/admin\/ticket\/file\/23\/faafe9b1df79e05f4eaf8e6516d7bfafbde2e1f4.png"
],
"created":"2016-09-23 19:31:20",
"updated":"1970-01-01 03:00:00"
}
],
"pagination":{
"per_page":100,
"total_count":0,
"page":1
}
}
Get list of tickets for connection to offers
GET /3.0/admin/tickets
Parameter Type Available & Default Description page integer Default: 1 REQUIRED
Page of stat entities limit integer Default: 100
Available: max 500 Limit of entities status string Available: open, closed
APPROVE OR REJECT TICKET FOR CONNECT AFFILIATE TO OFFER
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "do=approve" http://YOUR_API_DOMAIN/3.0/admin/ticket/17340/offer
> Response example:
{
"status":1,
"message":"Request is successfully"
}
Approve or reject ticket for connect affiliate to offer
POST /3.0/admin/ticket/{id}/offer
Parameter Type Available & Default Description do String Available: approve,
reject What need to do with a ticket
APPROVE OR REJECT TICKET FOR CONNECT AFFILIATE TO SMARTLINK
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "do=approve" http://YOUR_API_DOMAIN/3.0/admin/ticket/17340/smartlink
> Response example:
{
"status":1,
"message":"SmartLink privacy is updated"
}
Approve or reject ticket for connect affiliate to SmartLink
POST /3.0/admin/ticket/{ID}/smartlink
Parameter Type Available & Default Description do String Available: approve,
reject What need to do with a ticket
PIXEL LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "pid[]=610&moderation_status=0"
http://YOUR_API_DOMAIN/3.0/partner/pixels
> Response example:
{
"status":1,
"pixel":{
"1":{
"id":1,
"name":"...",
"code":"\u003Cscript\u003Ealert(\u0027123\u0027);\u003C\/script\u003E",
"code_type":"javascript",
"offer_id":"906",
"pid":"610",
"is_active":"0",
"moderation_status":"0",
"created_at":"2017-06-19 22:49:07",
"updated_at":"2017-06-19 22:49:07"
}
}
}
Get list of a partner’s pixels
GET /3.0/partner/pixels
Parameter Type Available & Default Description pid[] Integer affiliate’s ID
moderation_status Integer Available: Pending: 0, Rejected: -1, Approved: 1
Moderation status
PIXEL ADD
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "pid=610&offer_id=906&name=test&code=<script>test</script>&code_type=javascript" http://YOUR_API_DOMAIN/3.0/partner/pixel
> Response example:
{
"status":1,
"pixel":{
"id":2,
"name":"test",
"code":"\u003Cscript\u003Etest\u003C\/script\u003E",
"code_type":"javascript",
"offer_id":"906",
"pid":"610",
"is_active":"0",
"moderation_status":"0",
"created_at":"2017-06-21 03:34:51",
"updated_at":"2017-06-21 03:34:51"
}
}
Add a partner’s pixel
POST /3.0/partner/pixel
Parameter Type Available & Default Description pid Integer REQUIRED affiliate’s
ID offer_id Integer REQUIRED Offer’s ID name String REQUIRED Name code String
Available: <script>…code…</scipt>, <img …>, <iframe src=“…”></iframe> REQUIRED
Code code_type String Available: javascript, iframe, image REQUIRED Code type
is_active Integer Available: 0, 1 Active or not moderation_status Integer
Available: Pending: 0, Rejected: -1, Approved: 1 Moderation status
PIXEL EDIT
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "pid=610&offer_id=906&name=test2&code=<script>test2</script>&code_type=javascript" http://YOUR_API_DOMAIN/3.0/partner/pixel/2
> Response example:
{
"status":1,
"pixel":{
"id":2,
"name":"test2",
"code":"\u003Cscript\u003Etest2\u003C\/script\u003E",
"code_type":"javascript",
"offer_id":"906",
"pid":"610",
"is_active":"0",
"moderation_status":"0",
"created_at":"2017-06-21 03:34:51",
"updated_at":"2017-06-21 03:34:51"
}
}
Edit a partner’s pixel
POST /3.0/partner/pixel/{ID}
Parameter Type Available & Default Description name String Name code String
Available: <script>…code…</scipt>, <img …>, <iframe src=“…”></iframe> Code
code_type String Available: javascript, iframe, image Code type is_active
Integer Available: 0, 1 Active or not moderation_status Integer Available:
Pending: 0, Rejected: -1, Approved: 1 Moderation status
PIXEL REMOVE
curl -X DELETE --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/partner/pixel/2/remove
> Response example:
{
"status":1,
"pixel":{
"id":2,
"name":"test2",
"code":"\u003Cscript\u003Etest2\u003C\/script\u003E",
"code_type":"javascript",
"offer_id":"906",
"pid":"610",
"is_active":"0",
"moderation_status":"0",
"created_at":"2017-06-21 03:34:51",
"updated_at":"2017-06-21 03:34:51"
}
}
Delete a partner’s pixel
DELETE /3.0/partner/pixel/{ID}/remove
SMARTLINK CATEGORIES
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.0/admin/smartlink/categories
> Response example:
{
"status":1,
"data":[
{
"_id":"595e3b547e28fede7b8b456c",
"name":"test1",
"domain":"myDomen.com",
"description":null,
"use_https": false,
"privacy_level": "premoderated",
"excluded_affiliates": [],
"included_affiliates": [1],
"created_at":"2017-07-06 13:29:56",
"updated_at":"2017-07-06 13:29:56"
}
]
}
SmartLink categories list
GET /3.0/admin/smartlink/categories
Parameter Type Available & Default Description id Array[string] Available only
letters (a-f), numbers (0-9). Line length must be 24 characters SmartLink
categories ID name string SmartLink title
SMARTLINK CATEGORY
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "name=test&description=test" http://YOUR_API_DOMAIN/3.0/admin/smartlink/category
> Response example:
{
"status":1,
"data":{
"_id":"595fd4877e28fee8428b459f",
"name":"test",
"domain":"myDomen.com",
"description":"test",
"use_https": false,
"privacy_level": "premoderated",
"excluded_affiliates": [],
"included_affiliates": [1],
"created_at":"2017-07-07 18:35:51",
"updated_at":"2017-07-07 18:35:51"
}
}
Add new SmartLink category
POST /3.0/admin/smartlink/category
Parameter Type Available & Default Description name String REQUIRED Category
name description String Category description privacy_level String Available
values: “public”, “premoderated”, “private”. Default: “public” Privacy level
excluded_affiliates Array[integer] Excluded affiliate IDs included_affiliates
Array[integer] Included affiliate IDs tracking_domain String The domain name
(FQDN) for the tracking URL
SMARTLINK EDIT CATEGORY
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "name=test123&description=test" http://YOUR_API_DOMAIN/3.0/admin/smartlink/category/595fd4877e28fee8428b459f
> Response example:
{
"status":1,
"data":{
"_id":"595fd4877e28fee8428b459f",
"name":"test123",
"domain":"myDomen.com",
"description":"test",
"use_https": false,
"privacy_level": "premoderated",
"excluded_affiliates": [],
"included_affiliates": [1],
"created_at":"2017-07-07 18:35:51",
"updated_at":"2017-07-07 18:35:51"
}
}
Edit a SmartLink category
POST /3.0/admin/smartlink/category/{ID}
Parameter Type Available & Default Description name String Name of category
description String Description of the category tracking_domain String The domain
name (FQDN) for the tracking URL
SMARTLINK CATEGORY REMOVE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "" http://YOUR_API_DOMAIN/3.0/admin/smartlink/category/595fd4877e28fee8428b459f/remove
> Response example:
{
"status":1,
"data":{
"_id":"595fd4877e28fee8428b459f",
"name":"test123",
"domain":"myDomen.com",
"description":"test",
"use_https": false,
"privacy_level": "premoderated",
"excluded_affiliates": [],
"included_affiliates": [1],
"created_at":"2017-07-07 18:35:51",
"updated_at":"2017-07-07 18:35:51"
}
}
Remove a SmartLink category
POST /3.0/admin/smartlink/category/{ID}/remove
SMARTLINK OFFER COUNT
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "" http://YOUR_API_DOMAIN/3.0/admin/smartlink/category/595fd4877e28fee8428b459f/offers-count
> Response example:
{
"status":1,
"data":{
"count":2
}
}
Get offers’ count
GET /3.0/admin/smartlink/category/{id}/offers-count
PRESETS (ADMIN METHODS)
GET LIST OF PRESETS
curl -X GET \
'http://<YOUR_DOAMIN>/3.1/presets' \
-H 'api-key: 69cebe280a74bb8863a6d2b37df1f72b910e6a7c' \
> Response example:
{
"status": 1,
"presets": [
{
"id": "5f51755a535bac2217eb7619",
"name": "Test affiliate_manager 4",
"permissions": {
"automation": {
"affise-checker": {
"level": "deny"
}
},
"general": {
"marketplace": {
"level": "read"
},
"settings": {
"level": "deny"
}
},
"notificator": {
"client-subscription": {
"level": "write"
},
"transport-configuration": {
"level": "write"
},
"user-subscription": {
"level": "write"
}
},
"stats": {
"affiliate-postback": {
"level": "read"
},
"clicks-list": {
"level": "read"
},
"comparison-report": {
"level": "read"
},
"conversions-export": {
"level": "read"
},
"conversions-import": {
"level": "write"
},
"conversions-list": {
"level": "read"
},
"entity-account-manager": {
"level": "read",
"exceptions": {
"strings": []
}
},
"entity-affiliate-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"referral": {
"level": "deny"
},
"server-postback": {
"level": "read"
},
"slice-account_manager_id": {
"level": "deny"
},
"slice-advertiser_id": {
"level": "deny"
},
"slice-affiliate_id": {
"level": "read"
},
"slice-affiliate_manager_id": {
"level": "deny"
},
"slice-browser": {
"level": "deny"
},
"slice-city": {
"level": "read"
},
"slice-connection-type": {
"level": "deny"
},
"slice-country": {
"level": "read"
},
"slice-day": {
"level": "read"
},
"slice-device": {
"level": "read"
},
"slice-goal": {
"level": "read"
},
"slice-landing": {
"level": "deny"
},
"slice-mobile-carrier": {
"level": "deny"
},
"slice-offer_id": {
"level": "read"
},
"slice-os": {
"level": "read"
},
"slice-prelanding": {
"level": "deny"
},
"slice-smart_id": {
"level": "deny"
},
"slice-sub1": {
"level": "deny"
},
"slice-sub2": {
"level": "deny"
},
"slice-trafficback_reason": {
"level": "read"
},
"stats-export": {
"level": "read"
},
"view-custom": {
"level": "read"
},
"view-kpi": {
"level": "deny"
},
"view-retention-rate": {
"level": "deny"
}
},
"users": {
"entity-account-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-advertiser": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-affiliate": {
"level": "deny",
"exceptions": {
"ints": []
}
},
"entity-affiliate-manager": {
"level": "write",
"exceptions": {
"strings": []
}
},
"entity-common-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-preset": {
"level": "deny"
},
"view-users": {
"level": "deny"
}
}
},
"created_at": "2020-09-03T22:59:38Z",
"updated_at": "2020-09-03T22:59:38Z"
}
]
}
Get presets list
GET /3.1/presets
Parameter Type Available & Default Description page Integer Available: >=1; 1
page with results limit Integer Available: >=1; 50 results per page
CREATE PRESET
curl -X POST \
'http://<YOUR_DOAMIN>/3.1/presets' \
-H 'api-key: 69cebe280a74bb8863a6d2b37df1f72b910e6a7c' \
-H 'Content-Type: application/json' \
-d '{
"name": "Test affiliate_manager 4",
"permissions": {
"automation": {
"affise-checker": {
"level": "deny"
}
},
"general": {
"marketplace": {
"level": "read"
},
"settings": {
"level": "deny"
}
},
"notificator": {
"client-subscription": {
"level": "write"
},
"transport-configuration": {
"level": "write"
},
"user-subscription": {
"level": "write"
}
},
"stats": {
"affiliate-postback": {
"level": "read"
},
"clicks-list": {
"level": "read"
},
"comparison-report": {
"level": "read"
},
"conversions-export": {
"level": "read"
},
"conversions-import": {
"level": "write"
},
"conversions-list": {
"level": "read"
},
"entity-account-manager": {
"level": "read",
"default_level": "read",
"exceptions": {
"strings": {}
}
},
"entity-affiliate-manager": {
"level": "deny",
"exceptions": {
"strings": {}
}
},
"referral": {
"level": "deny"
},
"server-postback": {
"level": "read"
},
"slice-account_manager_id": {
"level": "deny"
},
"slice-advertiser_id": {
"level": "deny"
},
"slice-affiliate_id": {
"level": "read"
},
"slice-affiliate_manager_id": {
"level": "deny"
},
"slice-browser": {
"level": "deny"
},
"slice-city": {
"level": "read"
},
"slice-connection-type": {
"level": "deny"
},
"slice-country": {
"level": "read"
},
"slice-day": {
"level": "read"
},
"slice-device": {
"level": "read"
},
"slice-goal": {
"level": "read"
},
"slice-landing": {
"level": "deny"
},
"slice-mobile-carrier": {
"level": "deny"
},
"slice-offer_id": {
"level": "read"
},
"slice-os": {
"level": "read"
},
"slice-prelanding": {
"level": "deny"
},
"slice-smart_id": {
"level": "deny"
},
"slice-sub1": {
"level": "deny"
},
"slice-sub2": {
"level": "deny"
},
"slice-trafficback_reason": {
"level": "read"
},
"stats-export": {
"level": "read"
},
"view-custom": {
"level": "read"
},
"view-kpi": {
"level": "deny"
},
"view-retention-rate": {
"level": "deny"
}
},
"users": {
"entity-account-manager": {
"level": "deny",
"exceptions": {
"strings": {}
}
},
"entity-advertiser": {
"level": "deny",
"exceptions": {
"strings": {}
}
},
"entity-affiliate": {
"level": "deny",
"exceptions": {
"ints": {}
}
},
"entity-affiliate-manager": {
"level": "write",
"exceptions": {
"strings": {}
}
},
"entity-common-manager": {
"level": "deny",
"exceptions": {
"strings": {}
}
},
"entity-preset": {
"level": "deny"
},
"view-users": {
"level": "deny"
}
}
}
}'
> Response example:
{
"status": 1,
"preset": {
"id": "5f51755a535bac2217eb7619",
"name": "Test affiliate_manager 4",
"permissions": {
"automation": {
"affise-checker": {
"level": "deny"
}
},
"general": {
"marketplace": {
"level": "read"
},
"settings": {
"level": "deny"
}
},
"notificator": {
"client-subscription": {
"level": "write"
},
"transport-configuration": {
"level": "write"
},
"user-subscription": {
"level": "write"
}
},
"stats": {
"affiliate-postback": {
"level": "read"
},
"clicks-list": {
"level": "read"
},
"comparison-report": {
"level": "read"
},
"conversions-export": {
"level": "read"
},
"conversions-import": {
"level": "write"
},
"conversions-list": {
"level": "read"
},
"entity-account-manager": {
"level": "read",
"exceptions": {
"strings": []
}
},
"entity-affiliate-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"referral": {
"level": "deny"
},
"server-postback": {
"level": "read"
},
"slice-account_manager_id": {
"level": "deny"
},
"slice-advertiser_id": {
"level": "deny"
},
"slice-affiliate_id": {
"level": "read"
},
"slice-affiliate_manager_id": {
"level": "deny"
},
"slice-browser": {
"level": "deny"
},
"slice-city": {
"level": "read"
},
"slice-connection-type": {
"level": "deny"
},
"slice-country": {
"level": "read"
},
"slice-day": {
"level": "read"
},
"slice-device": {
"level": "read"
},
"slice-goal": {
"level": "read"
},
"slice-landing": {
"level": "deny"
},
"slice-mobile-carrier": {
"level": "deny"
},
"slice-offer_id": {
"level": "read"
},
"slice-os": {
"level": "read"
},
"slice-prelanding": {
"level": "deny"
},
"slice-smart_id": {
"level": "deny"
},
"slice-sub1": {
"level": "deny"
},
"slice-sub2": {
"level": "deny"
},
"slice-trafficback_reason": {
"level": "read"
},
"stats-export": {
"level": "read"
},
"view-custom": {
"level": "read"
},
"view-kpi": {
"level": "deny"
},
"view-retention-rate": {
"level": "deny"
}
},
"users": {
"entity-account-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-advertiser": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-affiliate": {
"level": "deny",
"exceptions": {
"ints": []
}
},
"entity-affiliate-manager": {
"level": "write",
"exceptions": {
"strings": []
}
},
"entity-common-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-preset": {
"level": "deny"
},
"view-users": {
"level": "deny"
}
}
},
"created_at": "2020-09-03T22:59:38Z",
"updated_at": "2020-09-03T22:59:38Z"
}
}
Create preset using JSON dataset
POST /3.1/presets
Parameter Type Available & Default Description name JSON String Preset name
REQUIRED permissions JSON full scope REQUIRED Permissions for preset type JSON
affiliate_manager; account_manager; eq=common_manager REQUIRED reset type
UPDATE PRESET
curl -X POST \
'http://<YOUR_DOAMIN>/3.1/presets/5d4c30c610dd212ea8dc98f5' \
-H 'api-key: 69cebe280a74bb8863a6d2b37df1f72b910e6a7c' \
-H 'Content-Type: application/json' \
-d '{
"name": "Test affiliate_manager 4 (update)",
"permissions": {
"automation": {
"affise-checker": {
"level": "write"
}
}
}
}'
> Response example:
{
"status": 1,
"preset": {
"id": "5f51755a535bac2217eb7619",
"name": "Test affiliate_manager 4 (update)",
"permissions": {
"automation": {
"affise-checker": {
"level": "write"
}
},
"general": {
"marketplace": {
"level": "read"
},
"settings": {
"level": "deny"
}
},
"notificator": {
"client-subscription": {
"level": "write"
},
"transport-configuration": {
"level": "write"
},
"user-subscription": {
"level": "write"
}
},
"stats": {
"affiliate-postback": {
"level": "read"
},
"clicks-list": {
"level": "read"
},
"comparison-report": {
"level": "read"
},
"conversions-export": {
"level": "read"
},
"conversions-import": {
"level": "write"
},
"conversions-list": {
"level": "read"
},
"entity-account-manager": {
"level": "read",
"exceptions": {
"strings": []
}
},
"entity-affiliate-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"referral": {
"level": "deny"
},
"server-postback": {
"level": "read"
},
"slice-account_manager_id": {
"level": "deny"
},
"slice-advertiser_id": {
"level": "deny"
},
"slice-affiliate_id": {
"level": "read"
},
"slice-affiliate_manager_id": {
"level": "deny"
},
"slice-browser": {
"level": "deny"
},
"slice-city": {
"level": "read"
},
"slice-connection-type": {
"level": "deny"
},
"slice-country": {
"level": "read"
},
"slice-day": {
"level": "read"
},
"slice-device": {
"level": "read"
},
"slice-goal": {
"level": "read"
},
"slice-landing": {
"level": "deny"
},
"slice-mobile-carrier": {
"level": "deny"
},
"slice-offer_id": {
"level": "read"
},
"slice-os": {
"level": "read"
},
"slice-prelanding": {
"level": "deny"
},
"slice-smart_id": {
"level": "deny"
},
"slice-sub1": {
"level": "deny"
},
"slice-sub2": {
"level": "deny"
},
"slice-trafficback_reason": {
"level": "read"
},
"stats-export": {
"level": "read"
},
"view-custom": {
"level": "read"
},
"view-kpi": {
"level": "deny"
},
"view-retention-rate": {
"level": "deny"
}
},
"users": {
"entity-account-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-advertiser": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-affiliate": {
"level": "deny",
"exceptions": {
"ints": []
}
},
"entity-affiliate-manager": {
"level": "write",
"exceptions": {
"strings": []
}
},
"entity-common-manager": {
"level": "deny",
"exceptions": {
"strings": []
}
},
"entity-preset": {
"level": "deny"
},
"view-users": {
"level": "deny"
}
}
},
"created_at": "2020-09-03T22:59:38Z",
"updated_at": "2020-09-03T23:16:22Z"
}
}
Update preset using JSON dataset
POST /3.1/presets/{preset_id}
Parameter Type Available & Default Description name JSON String Preset name
permissions JSON REQUIRED Permissions for update
DELETE PRESET
curl -X DELETE \
'http://<YOUR_DOAMIN>/3.1/presets/5d4c30c610dd212ea8dc98f5' \
-H 'api-key: 69cebe280a74bb8863a6d2b37df1f72b910e6a7c'
> Response example:
{
"status": 1
}
Delete preset by id
DELETE /3.1/presets/{preset_id}
AUTOMATION (ADMIN METHODS)
KPI AUTOMATION LIST
curl -X GET \
'http://<YOUR_DOAMIN>/3.1/automation/kpi' \
-H 'api-key: {API-KEY}' \
> Response example:
{
"items":[
],
"pagination":{
"page": 1,
"per_page": 10,
"total_count": 0
},
"status":1
}
Get list of kpi automation
GET /3.1/automation/kpi
Parameter Type Available & Default Description page Integer 1 Page of entities
limit Integer Default: 100
Available: max 500 Limit of entities
CREATE NEW KPI AUTOMATION
curl --location --request POST 'http://YOUR_API_DOMAIN/3.1/automation/kpi' \
--header 'Api-key: {API-KEY}' \
--form 'offers[]="3"' \
--form 'affiliates[]="1"' \
--form 'action_type="block"' \
--form 'period="hour"' \
--form 'sub="sub1"' \
--form 'goal1="1"' \
--form 'goal2="2"' \
--form 'notify_manager="0"' \
--form 'kpi="0.1"'
> Response example:
{
"status": 1,
"message": {
"id": "5fcf6e20f28f89004e187664",
"offers": [
"3"
],
"period": "hour",
"action_type": "block",
"change_to": null,
"affiliates": [
1
],
"sub": "sub1",
"goal1": "1",
"goal2": "2",
"kpi": 0.1,
"notify_manager": 0
}
}
Create new kpi automation
POST /3.1/automation/kpi
Parameter Type Available & Default Description offers Array[integer] Only one
offer id is available Offer ID REQUIRED action_type String “block”,“conversion”
REQUIRED period String “hour”,“day”,“week”,“month” REQUIRED sub String
“sub1”,“sub2”,“sub3”,“sub4”,“sub5” REQUIRED only for action_type == block
change_to String “confirmed”,“pending”,“declined”,“hold” REQUIRED only for
action_type == conversion affiliates Array[integer] Affiliate IDs REQUIRED only
for action_type == block goal1 String REQUIRED goal2 String REQUIRED kpi Float
REQUIRED notify_manager Integer Available: 0, 1 REQUIRED
EDIT KPI AUTOMATION
curl --location --request POST 'http://YOUR_API_DOMAIN/3.1/automation/kpi/5fce42c5f28f8900143f3463' \
--header 'Api-key: {API-KEY}' \
--form 'offers[]="3"' \
--form 'affiliates[]="1"' \
--form 'action_type="block"' \
--form 'period="hour"' \
--form 'sub="sub1"' \
--form 'goal1="1"' \
--form 'goal2="2"' \
--form 'notify_manager="0"' \
--form 'kpi="0.1"'
> Response example:
{
"status": 1,
"message": {
"id": "5fce42c5f28f8900143f3463",
"offers": [
"3"
],
"period": "hour",
"action_type": "block",
"change_to": null,
"affiliates": [
1
],
"sub": "sub1",
"goal1": "1",
"goal2": "2",
"kpi": 0.1,
"notify_manager": 0
}
}
Edit kpi automation
POST /3.1/automation/kpi/{ID}
Parameter Type Available & Default Description offers Array[integer] Only one
offer id is available Offer ID REQUIRED action_type String “block”,“conversion”
REQUIRED period String “hour”,“day”,“week”,“month” REQUIRED sub String
“sub1”,“sub2”,“sub3”,“sub4”,“sub5” REQUIRED only for action_type == block
change_to String “confirmed”,“pending”,“declined”,“hold” REQUIRED only for
action_type == conversion affiliates Array[integer] Affiliate IDs REQUIRED only
for action_type == block goal1 String REQUIRED goal2 String REQUIRED kpi Float
REQUIRED notify_manager Integer Available: 0, 1 REQUIRED
REMOVE KPI AUTOMATION
curl --location --request DELETE 'http://YOUR_API_DOMAIN/3.1/automation/kpi/5fce42c5f28f8900143f3463' \
--header 'Api-key: {API-KEY}'
> Response example:
{
"status": 1,
"message": {
"message":"success deleted"
}
}
Remove kpi automation
DELETE /3.1/automation/kpi/{ID}
KPI AUTOMATION CHANGES
Kpi automation types:
* add
* update
* delete
curl -X GET \
'http://<YOUR_DOAMIN>/3.1/automation/kpi/change-logs' \
-H 'api-key: {API-KEY}' \
> Response example:
{
"items":[
],
"pagination":{
"page": 1,
"per_page": 10,
"total_count": 0
},
"status":1
}
Get list of kpi automation changes
GET /3.1/automation/kpi/change-logs
Parameter Type Available & Default Description filter[date_from] String
Available: YYYY-MM-DD REQUIRED filter[date_to] String Available: YYYY-MM-DD
REQUIRED page Integer 1 Page of entities limit Integer 10 Limit of entities
offers Array[integer] Offers ID’s affiliates Array[integer] Affiliates ID’s type
Array[integer] Array of kpi automation types. See Types
KPI AUTOMATION BLOCK LOG
curl -X GET \
'http://<YOUR_DOAMIN>/3.1/automation/kpi/block-logs' \
-H 'api-key: {API-KEY}' \
> Response example:
{
"status": 1,
"items": [
{
"created_at": "2020-10-05 19:59:22",
"offer_id": 2,
"affiliate_id": 2,
"sub_index": "data",
"sub_value": "data",
"action": "data",
"additional_data": null
}
],
"pagination": {
"per_page": 5,
"total_count": 1,
"page": 1
}
}
Get list of kpi automation block logs
GET /3.1/automation/kpi/block-logs
Parameter Type Available & Default Description page Integer 1 Page of entities
limit Integer Default: 100
Available: max 500 Limit of entities filter[date_from] String Available:
YYYY-MM-DD REQUIRED filter[date_to] String Available: YYYY-MM-DD REQUIRED
filter[sub_index] String Sub index filter[sub_value] String Sub value
filter[action] String Action filter[offers] Array[integer] Offers ID’s
filter[affiliates] Array[integer] Affiliates ID’s
CR AND SUB AUTOMATION BLOCK LOG
curl -X GET \
'http://<YOUR_API_DOMAIN>/3.1/automation/cr-and-sub/block-logs?filter[date_from]=2020-12-01&filter[date_to]=2020-12-08' \
-H 'api-key: {API-KEY}' \
> Response example:
{
"status": 1,
"rules": [
{
"advertiser": {
"id": "5bc9d7c16d73e41c008b4567",
"title": "Test advertiser"
},
"offer": {
"id": "4",
"title": "test offer 4"
},
"affiliate": {
"id": "3",
"title": "test1234"
},
"rule_id": "5fe0abb38e36eb001a2efb82",
"sub1": "",
"sub2": "",
"created_at": "2020-12-21 17:15:15",
"current_cr": 0,
"cr_thresholds_min": "10.000000",
"cr_thresholds_max": "50.000000",
"type": "disabled affiliate"
}
],
"pagination": {
"per_page": 10,
"total_count": 1,
"page": 1
}
}
Get list of cr and sub automation block logs
GET /3.1/automation/cr-and-sub/block-logs
Parameter Type Available & Default Description page Integer 1 Page of entities
limit Integer Default: 100
Available: max 500 Limit of entities filter[date_from] String Available:
YYYY-MM-DD REQUIRED filter[date_to] String Available: YYYY-MM-DD REQUIRED
filter[advertisers] Array[string] Advertisers ID’s filter[offers] Array[integer]
Offers ID’s filter[affiliates] Array[integer] Affiliates ID’s
OTHER MANAGING
ISP LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/isp?country=kz
> Response example:
{
"isps":[
{
"country":"KZ",
"name":"reliablesite.net llc"
},
{
"country":"KZ",
"name":"smartnet too"
},
{
"country":"KZ",
"name":"betting office olimp kz llc"
}
],
"pagination":{
"page":1,
"per_page":2147483647,
"total_count":3
},
"status":1
}
Get ISP list
GET /3.1/isp
Parameter Type Available & Default Description country String REQUIRED Country
code. Example: “US” q String Search query
COUNTRIES LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/countries
> Response example:
{
"countries":[
{
"code":"KP",
"name":"North Korea"
},
{
"code":"PF",
"name":"French Polynesia"
},
{
"code":"EG",
"name":"Egypt"
},
{
"code":"DE",
"name":"Germany"
},
{
"code":"GI",
"name":"Gibraltar"
}
],
"status":1
}
Get countries list
GET /3.1/countries
REGIONS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/regions?country[]=US&code[]=1&code[]=2
> Response example:
{
"status":1,
"regions":[
{
"id":2,
"name":"Alaska",
"country_code":"US"
},
{
"id":1,
"name":"Alabama",
"country_code":"US"
}
]
}
Get regions list
GET /3.1/regions
Parameter Type Available & Default Description country Array[string] REQUIRED
Country code. Example: “US” code Array[integer] Filter regions by id
CITIES LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/cities?country[]=US&code[]=1&code[]=2
> Response example:
{
"status": 1,
"cities": [
{
"id": 1,
"region_code": 10,
"name": "Florida",
"country_code": "US",
"region": "Florida"
},
{
"id": 2,
"region_code": 5,
"name": "California",
"country_code": "US",
"region": "California"
}
],
}
Get cities list
GET /3.1/cities
Parameter Type Available & Default Description country Array[string] REQUIRED
Country code. Example: “IT” code Array[integer] Filter cities by id
CONNECTION TYPES LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/connection-types
> Response example:
{
"status":1,
"types":[
"wi-fi",
"cellular",
"other"
]
}
Get connection types list
GET /3.1/connection-types
VENDORS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/vendors?q=next
> Response example:
{
"status":1,
"vendors":[
"Nextbit",
"Next",
"NextBook",
"NEXTAB",
"Nextel",
"NextTab",
"NEXTPAD",
"NextWolf"
]
}
Get vendors list
GET /3.1/vendors
Parameter Type Available & Default Description q String Search query
OSES LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/oses
> Response example:
{
"oses":{
"0":"Firefox OS",
"1":"3DS System Software",
"2":"DSi System Software",
"4":"VictorReader Stream",
"5":"ThreadX",
"6":"Feedfetcher",
"7":"Maemo",
"8":"Series 60",
"9":"Android with AOKP",
"10":"Apple TV Software"
},
"pagination":{
"page":1,
"per_page":2147483647,
"total_count":99
},
"status":1
}
Get oses list
GET /3.1/oses
OS VERSIONS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/oses/macOS
> Response example:
{
"pagination":{
"page":1,
"per_page":2147483647,
"total_count":21
},
"status":1,
"versions":[
"11.0",
"10.12",
"10.13",
"10.19",
"10.17",
"10.16",
"10.18",
"10.12.1",
"10.12.2",
"10.12.3",
"10.12.4",
"10.12.5",
"10.12.6",
"10.13.1",
"10.13.2",
"10.13.4",
"10.13.3",
"10.14.0",
"10.12.8",
"10.13.5",
"10.13.6"
]
}
Get os versions list
GET /3.1/oses/{OS}
Parameter Type Available & Default Description OS String One of OS
STATUS CODES
REVIEW ALL GLOBAL ERRORS FOR THE API SO YOU CAN GET BACK TO WORK FAST.
400 - Bad Request
The 400 Bad Request error is an HTTP status code that means that the request you
sent to the website server was somehow incorrect or corrupted ((e.g., malformed
request syntax, invalid request message framing, or deceptive request routing).)
and the server couldn’t process it.
401 - Token is necessary
Current request requires user authentication. Your API key may be invalid, or
you’ve attempted to access the wrong data center.
403 - Auth Denied
You are not permitted to access this resource.Check if user has the necessary
permissions for the request.
404 - Resource Not Found
The HTTP 404 Not Found Error means that the webpage you were trying to reach
could not be found on the server. It is a Client-side Error which means that
either the page has been removed or that you typed in the URL incorrectly.
500 - Server error,Please contact your administrator
The 500 Internal Server Error is a very general HTTP status code that means
something has gone wrong on the web site’s server but the server could not be
more specific on what the exact problem is.
501 - Request uri not found
The requested URI resource could not be found. The server either does not
recognize the request method or does not support the functionality required to
fulfill the request.
502 Bad Gateway
The server, while acting as a gateway or proxy, received an invalid response
from an inbound server it accessed while attempting to fulfill the request.
BILLING API
The affiliates billing API methods are available only for the customers of
Scale, Custom and Trial plans.
GET PAYMENTS LIST
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/payments
> Response example:
{
"status": 1,
"payments": [
{
"id": 5,
"pid": 1,
"manager_id": null,
"posted_date": "2022-03-02 17:28:29",
"pay_sys": 1,
"pay_sys_name": "Webmoney",
"pay_acc": "test-update-payment-account",
"status": "4",
"revenue": "52.12000000",
"ref_revenue": null,
"currency": "2",
"currency_code": "USD",
"comment": "test-update-comment",
"notes": "test-update-note",
"cpa_actions": [
"62164a9a5a8b7e788f752f13"
],
"ref_ids": [],
"details": {
"details": {
"4": {
"cost": {
"22.00000000": {
"count": 1,
"currency": 2
}
},
"title": "test 4"
}
},
"count": 1
},
"additional_payments": {
"9": {
"posted_date": "2022-03-31 18:00:55",
"revenue": "5.02000000",
"currency": "2",
"comment": "test-add-correction"
}
},
"updated_at": "2022-03-03 17:28:29"
}
],
"pagination": {
"page": 1,
"limit": 100,
"total": 1
}
}
Get payments list
GET /3.1/payments
Parameter Type Available & Default Description date_from String REQUIRED The
date from (format YYYY-MM-DD) date_to String REQUIRED The date to (format
YYYY-MM-DD) id Array[integer] Filter by payment invoice ids status
Array[integer] Filter by payment invoice status. Possible values (1 - waiting ,
2 - completed, 3 - paid partly, 4 - pending, -1 - declined) aid Array[integer]
Filter by affilaite ids manager_id Array[string] Filter by affilaite manager ids
payment_system Array[string] Filter by payment systems payment_account
Array[string] Filter by payment accounts update_from_date String The updated
date from (format YYYY-MM-DD) update_to_date String The updated date to (format
YYYY-MM-DD) update_from_hour Integer The updated from hour (between 0 to 23)
update_to_hour Integer The updated to hour (between 0 to 23) page Integer Page
of entities limit Integer Default: 100
Limit of entities. From 0 to 100
GET PAYMENT INVOICE INFO
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
http://YOUR_API_DOMAIN/3.1/payments/{ID}
> Response example:
{
"status": 1,
"payment": {
"id": 5,
"pid": 1,
"manager_id": null,
"posted_date": "2022-03-02 17:28:29",
"pay_sys": 1,
"pay_sys_name": "Webmoney",
"pay_acc": "WMR: 344324\r\nWMZ: 23423423",
"status": "1",
"revenue": "22.00000000",
"ref_revenue": null,
"currency": "2",
"currency_code": "USD",
"comment": "test",
"notes": "test",
"cpa_actions": [
"62164a9a5a8b7e788f752f13"
],
"ref_ids": [],
"details": {
"details": {
"4": {
"cost": {
"22.00000000": {
"count": 1,
"currency": 2
}
},
"title": "test 4"
}
},
"count": 1
},
"additional_payments": [],
"updated_at": "2022-03-03 17:28:29"
}
}
Get payment invoice info
GET /3.1/payments/{ID}
CREATE PAYMENT INVOICE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "aid=1&sum=100¤cy=1¬e=test" http://YOUR_API_DOMAIN/3.1/payments/create-for-affiliate
> Response example:
{"status":1,"message":"Payment generates will take a few minutes"}
POST /3.1/payments/create-for-affiliate
Parameter Type Available & Default Description aid Integer REQUIRED Affiliate Id
sum Number REQUIRED Payment invoice sum currency Integer REQUIRED Currency Id
(/3.0/admin/currency?extended=1) note String Note for payment invoice
GENERATE PAYMENT INVOICES FOR AFFILIATES
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "date=2023-01-01¬e=test" http://YOUR_API_DOMAIN/3.1/payments/generate
> Response example:
{"status":1,"message":"Payment generates will take a few minutes"}
POST /3.1/payments/generate
Parameter Type Available & Default Description date String REQUIRED To
generation day (format YYYY-MM-DD) aid Integer Affiliate Id note String Note for
payment invoice exclude_aids Array[integer] Exclude affiliate ids
UPDATE PAYMENT INVOICE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "comment=test" http://YOUR_API_DOMAIN/3.1/payments/{ID}
> Response example:
{"status":1,"result":true}
POST /3.1/payments/{ID}
Custom form parameters (should fill at least one)
Parameter Type Available & Default Description payment_account String Payment
account information status Integer Status (1 - waiting, 2 - completed, 3 - paid
partly, 4 - pending, -1 - declined) comment String Comment for payment invoice
note String Note for payment invoice
ADD CORRECTION VALUE FOR PAYMENT INVOICE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "revenue=10&comment=bonus" http://YOUR_API_DOMAIN/3.1/payments/{ID}/add-correction
> Response example:
{"status":1,"result":true}
POST /3.1/payments/{ID}/add-correction where {ID} is payment invoice id
Parameter Type Available & Default Description revenue Number REQUIRED Revenue
comment String REQUIRED Comment for correction payment
REMOVE CORRECTION VALUE FOR PAYMENT INVOICE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" --location --request DELETE http://YOUR_API_DOMAIN/3.1/payments/del-correction/{ID}
> Response example:
{"status":1,"result":true}
DELETE /3.1/payments/del-correction/{ID} where {ID} is payment invoice
correction sum id
REMOVE PAYMENT INVOICE
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" --location --request DELETE http://YOUR_API_DOMAIN/3.1/payments/delete/{ID}
> Response example:
{"status":1,"result":true}
DELETE /3.1/payments/delete/{ID} where {ID} is payment invoice id
REMOVE SEVERAL PAYMENT INVOICES
curl --header "API-Key:23df424b0a53b0899f78685966243ee61" /
--data "ids[]=1&ids[]=2" http://YOUR_API_DOMAIN/3.1/payments/bulk-delete
> Response example:
{"status":1,"result":{"1":true,"2":false}}
POST /3.1/payments/bulk-delete
Parameter Type Available & Default Description ids Array[integer] REQUIRED
Payment invoice id
shell