List of affiliate programs

Parameters

HTTP method

Access rights

URL

Parameters

Note

GET advcampaigns https://api.admitad.com/advcampaigns/
  • offset**
  • limit**
  • language***
  • website****
  • has_tool*****

Returns the list of affiliate programs.*

GET advcampaigns https://api.admitad.com/advcampaigns/{id}/
  • language***

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 tool availability. Possible values are:
    • deeplink
    • products
    • retag
    • arecord
    • postview
    • lost_orders
    • broker_traffic

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",
                    "hold_time": 120,
                    "type": "sale",
                    "name": "Action name",
                    "id": 1
                },
                {
                    "hold_time": 30,
                    "payment_size": "1.30%",
                    "type": "sale",
                    "name": "Paid order",
                    "id": 892
                },
                {
                    "payment_size": "11.00",
                    "hold_time": 15,
                    "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,
            "max_hold_time": 120,
            "id": 6,
            "cr": null,
            "ecpc": null,
            "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
        }
    ],
    "_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 tariffs for prepaid actions

сr

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

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

max_hold_time

The maximum hold 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

Allowed traffic types

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”