List of affiliate programs¶
Parameters¶
HTTP method |
Access rights |
URL | Parameters |
Note |
|---|---|---|---|---|
| GET | advcampaigns | https://api.admitad.com/advcampaigns/ |
|
Returns the list of affiliate programs.* |
| GET | advcampaigns | https://api.admitad.com/advcampaigns/{id}/ |
|
Returns the affiliate program, where id is the affiliate program identifier.* |
* Returns the result in the JSON format.
** Sets skipping and the number of records returned. For example limit=5&offset=2.
*** Internationalization of categories (ru by default). E.g. :doc:`language=ru </params/language>.
**** Ad space identifier. For example, website=12342, allows to determine the need for moderation when a program is connected.
- ***** Filter by the availability of a tool for a program. Possible values:
- deeplink
- products
- retag
- lost_orders
- coupons
- basket_tracking
- tracking_in_mobile_site
- tracking_in_mobile_app
vendor_bonus
****** Filter by allowed traffic sources of the program. For example traffic_id=1. To get the IDs of traffic sources, use this method.
Using this method you can export the list of the programs from the catalog and their standard rates. If you want to see exclusive rates of the programs for your ad space, use :doc:`this method <./advcampaigns-website-list>.
Example of use¶
Example of a request with utility ``curl``:
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/advcampaigns/?limit=1&website=1234124
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/advcampaigns/3/?language=ru
Example of the response from the API server in the JSON format:
{
"results": [
{
"status": "active",
"rating": "5.00",
"image": "//cdn.admitad.com/media/campaign/images/2012/06/13/4b9182dae3a6758eb12f76a76a5b3f26.jpg",
"description": "Gmail is a mail service by google",
"traffics": [
{
"enabled": false,
"name": "Type 1",
"type": "lead",
"id": 1
},
{
"enabled": false,
"name": "Type 2",
"type": "sale",
"id": 2
}
],
"actions": [
{
"payment_size": "50.00",
"type": "sale",
"name": "Action name",
"id": 1
},
{
"payment_size": "1.30%",
"type": "sale",
"name": "Paid order",
"id": 892
},
{
"payment_size": "11.00",
"type": "lead",
"name": "Registration",
"id": 11
}
],
"site_url": "http://www.gmail.com/",
"regions": [
{
"region": "BY"
},
{
"region": "CA"
},
{
"region": "DE"
},
{
"region": "KZ"
},
{
"region": "RU"
},
{
"region": "US"
}
],
"currency": "USD",
"geotargeting": true,
"coupon_iframe_denied": false,
"connected": true,
"id": 6,
"cr": 9.83,
"ecpc": 45.32,
"epc": 4532.45,
"cr_trend": 3.3323,
"ecpc_trend": 2.3441,
"epc_trend": 241.8345,
"categories": [
{
"language": "en",
"name": "Shop",
"parent": null,
"id": 1
},
{
"language": "en",
"name": "Online Games",
"parent": null,
"id": 2
},
{
"language": "en",
"name": "Browser",
"parent": {
"language": "en",
"name": "Online Games",
"parent": null,
"id": 2
},
"id": 3
},
{
"language": "en",
"name": "Other",
"parent": null,
"id": 5
},
{
"language": "en",
"name": "Finances",
"parent": {
"language": "en",
"name": "Other",
"parent": null,
"id": 5
},
"id": 6
},
{
"language": "en",
"name": "Subcategory",
"parent": {
"language": "en",
"name": "Other",
"parent": null,
"id": 5
},
"id": 17
}
],
"name": "Campaign1"
"action_type": "sale",
"individual_terms": false,
"allow_deeplink": true,
"action_testing_limit": 500,
"mobile_device_type": "smartphone",
"mobile_os_type": "android",
"mobile_os": "android 9.0",
"action_countries": ["BY", "GE", "RU"],
"allow_actions_all_countries": false,
}
],
"_meta": {
"count": 4,
"limit": 1,
"offset": 0
}
}
Description of API server response fields¶
Name |
Description |
|---|---|
| id | Affiliate program ID |
| name | Name of affiliate program |
| image | Affiliate program logo |
| status | Affiliate program status |
| rating | Affiliate program rating |
| description | Affiliate program description |
| raw_description | Affiliate program description containing html tags |
| site_url | Affiliate program website |
| exclusive | Exclusive affiliate program |
| currency | System currencies |
| regions | Ad space regions |
| categories | Categories of affiliate programs |
| actions | The list of rates for prepaid actions |
| cr | Indicator of the average conversion rate |
| cr_trend | Changes in the indicator of the average conversion rate |
| ecpc | Average eCPC indicator |
| ecpc_trend | Changes in the indicator of the average eCPC |
| epc | EPC indicator |
| epc_trend | change of the EPC indicator |
| rate_of_approve | Approval rate |
| more_rules | Additional rules |
| geotargeting | Splitting payment depending on client’s country |
| coupon_iframe_denied | Prohibition of coupon traffic via iframe |
| activation_date | Date of program start |
| modified_date | Date of last change to the program |
| connected | The program has joined one or more publisher’s ad spaces |
| avg_hold_time | Actual average hold time |
| avg_money_transfer_time | Average payment time |
| denynewwms | The recruitment of new publishers has been suspended |
| goto_cookie_lifetime | Postclick cookie life time |
| retag | ReTag |
| show_products_links | Product feeds links are allowed (true, false) |
| traffics | Traffic sources |
| landing_code | Related landing page code |
| landing_title | Related landing page header |
| action_type | Type of action (lead/sale) |
| individual_terms | Individual terms |
| allow_deeplink | Ability to use “Deeplink” |
allow_actions_all_counties |
This program is available in all countries (true/false) |
| action_countries | Countries from which actions are paid for ([“GE”, “RU”, ...]/null) |
| action_testing_limit | After the specified number of actions is generated, the publisher must halt traffic to receive feedback from the advertiser. For mobile programs and online games only (int/null) |
| mobile_os_type | Operating system supported by the app For mobile programs only (“android”/”ios”/null) |
| mobile_os | The application installation is supported starting from the current version. For mobile programs only (“android 6.0”/”android all”/”ios 11.0”/”ios all”/null) |
| mobile_device_type | Device supported by the app For mobile programs only (“smartphone”/”tablet”/”all”/null) |