Reports by ad spaces¶

Parameters¶

HTTP method	Access rights	URL	Parameters	Note
GET	statistics	`https://api.admitad.com/statistics/websites/`	offset limit date_start * date_end * website * campaign * subid * total order_by ***	Statistical data on ad spaces.*

* Returns the result in the JSON format.

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

*** Filter by date, ad spaces, affiliate programs, and subID, respectively. For example campaign=3&campaign=4&website=8&date_start=01.01.2011, where the values are identifiers of filtered categories or filtered data. The values for dates should be in format ‘%d.%m.%Y’ - ‘01.05.2012’.

**** The parameter that allows to obtain aggregated data for the entire request. Possible values: 1/0 - aggregated data/not aggregated result

***** Sorting order. Possible values:

website_id

website_name

views

clicks

ctr

ecpc

ecpm

cr

leads_sum

sales_sum

payment_sum_open

payment_sum_approved

payment_sum_declined

currency.

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/statistics/websites/?date_start=01.01.2011&limit=1&order_by=-payment_sum&offset=1

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

{
    "results": [
        {
            "leads_sum": 24,
            "payment_sum_declined": 0.0,
            "ctr": 2413.5714,
            "views": 7,
            "website_id": "25",
            "clicks": 16895,
            "payment_sum_approved": 0.0,
            "currency": "RUB",
            "website_name": "site3_of_webmaster1",
            "ecpm": 1513735.71,
            "sales_sum": 1,
            "cr": 0.0015,
            "ecpc": 0.62,
            "payment_sum_open": 10596.15
        }
    ],
    "_meta": {
        "count": 3,
        "limit": 1,
        "offset": 1
    }
}

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

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/statistics/websites/?date_start=01.01.2011&limit=1&order_by=-payment_sum&offset=1&total=1

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

[
    {
        "leads_sum": 21594304,
        "payment_sum": 3382089.02,
        "views": 7337610,
        "payment_sum_declined": 1705783.09,
        "actions_sum_total": 22023257,
        "payment_sum_approved": 1646173.57,
        "currency": "RUB",
        "sales_sum": 21694727,
        "payment_sum_open": 1735915.45,
        "clicks": 7064253
    }
]

Description of API server response fields¶

Name	Description
website_name	Name of ad space
website_id	Ad space ID
currency	System currencies
leads_sum	Number of leads
sales_sum	Number of sales
payment_sum_declined	The amount related to the rejected actions
payment_sum_approved	The amount related to the confirmed actions
payment_sum_open	The amount related to the actions on hold
views	The number of impressions
clicks	The number of clicks
ctr	CTR
ecpc	eCPC
cr	Conversion rate
ecpm	eCPM