Reports on publishers¶

Parameters¶

HTTP method	Access rights	URL	Parameters	Note
GET	advertiser_statistics	`https://api.admitad.com/advertiser/{c_id}/statistics/webmasters/`	offset limit start_date* end_date* webmasters* websites* groups* channels* actions* order_by**	Statistical data on publishers where с_id is the affiliate program ID.*

* Returns the result in the JSON format.

** Sets skipping and the number of records returned. For example limit=5&offset=2.

*** Filter by date, publishes, ad space, group, channel, and rate, respectively. For example websites=3&websites=4&groups=8&start_date=01.01.2011&end_date=11.01.2011, where values are the identifiers of filtered categories or filtered data. The values for dates must be in the format %d.%m.%Y - 01.05.2012.

**** Sorting order. Possible values:

clicks

cr

ctr

username

ecpc

ecpm

leads_approved

leads_declined

leads_open

new_rate

payment_sum_all

payment_sum_approved

payment_sum_declined

payment_sum_open

sales_approved

sales_declined

sales_open

views

Sign ‘-‘ before the value means inverse sort order. For example, order_by=-clicks&order_by=cr.

Example of use¶

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET "https://api.admitad.com/advertiser/1/statistics/webmasters/?limit=2"

Example of the response from the API server in the JSON format:

{
    "results": [
        {
            "username": "ngvl",
            "sales_approved": "0",
            "sales_declined": "0",
            "payment_sum_approved": "1072230.00",
            "ctr": 1107992.31,
            "views": 13,
            "currency": "RUB",
            "leads_open": "1343",
            "payment_sum_open": "65260.00",
            "ecpm": 87499230.77,
            "payment_sum_declined": "0.00",
            "cr": 17.0,
            "leads_declined": "0",
            "sales_open": "0",
            "leads_approved": "23146",
            "ecpc": 7.9,
            "clicks": 144039
        },
        {
            "username": "fici",
            "sales_approved": "0",
            "sales_declined": "0",
            "payment_sum_approved": "6648.00",
            "ctr": 0.0,
            "views": 0,
            "currency": "RUB",
            "leads_open": "11",
            "payment_sum_open": "288.00",
            "ecpm": 0.0,
            "payment_sum_declined": "0.00",
            "cr": 3.93,
            "leads_declined": "0",
            "sales_open": "0",
            "leads_approved": "10651",
            "ecpc": 2.45,
            "clicks": 271534
        }
    ],
    "_meta": {
        "count": 1703,
        "limit": 2,
        "offset": 0
    }
}

Description of API server response fields¶

Name	Description
clicks	Clicks
currency	Currency
cr	Conversion rate
ctr	CTR
username	Publisher
ecpc	eCPC
ecpm	eCPM
leads_approved	Number of confirmed leads
leads_declined	Number of rejected leads
leads_open	Number of leads on hold
payment_sum_approved	The amount related to the confirmed actions
payment_sum_declined	The amount related to the rejected actions
payment_sum_open	The amount related to the actions on hold
sales_approved	Number of confirmed sales
sales_declined	Number of rejected sales
sales_open	Number of sales on hold
views	The number of impressions