#329: Статистика веб-мастера

Отредактирована: 10 дней назад

Статистика по площадкам

Параметры

HTTP- методПрава доступаURLПараметрыПримечание
GETstatisticshttps://api.admitad.com/statistics/websites/offset**Статистические данные по площадкам*
limit**
date_start***
date_end***
website***
campaign***
subid ***
total****
order_by*****

* Возвращает результат в формате JSON.

* Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

*** Фильтр по датам, площадкам, партнерским программам и SubID соответственно. Например campaign=3&campaign=4&website=8&date_start=01.01.2011, где значения — это идентификаторы фильтруемых категорий или фильтруемые данные. Значения для дат должны быть в формате '%d.%m.%Y' - '01.05.2012'.

**** Параметр, позволяющий получить агрегированные данные по всему запросу. Возможные значения: 1/0 — агрегированные данные/не агрегированный результат.

***** Порядок сортировки. Возможные значения:

  • website_id
  • website_name
  • views
  • clicks
  • ctr
  • ecpc
  • ecpm
  • cr
  • leads_sum
  • sales_sum
  • payment_sum_open
  • payment_sum_approved
  • payment_sum_declined
  • currency
    Знак '-' перед значением означает обратный порядок. Например, order_by=-clicks&order_by=cr.

Пример использования

Пример запроса с использованием утилиты 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

Пример ответа API-сервера в формате JSON:

{  
    "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  
    }  
}

Пример запроса с использованием утилиты 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

Пример ответа API-сервера в формате JSON:

[  
    {  
        "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  
    }  
]
НазваниеОписание
website_nameНазвание площадки
website_idИдентификатор площадки
currencyСистемные валюты
leads_sumКоличество лидов
sales_sumКоличество продаж
payment_sum_declinedСумма по отклоненным действиям
payment_sum_approvedСумма по подтверждённым действиям
payment_sum_openСумма по открытым действиям
viewsКоличество показов
clicksКоличество кликов
ctrCTR
ecpceCPC
crКонверсия
ecpmeCPM

Статистика по партнерским программам

Параметры

HTTP- методПрава доступаURLПараметрыПримечание
GETstatisticshttps://api.admitad.com/statistics/campaigns/offset**Статистические данные по партнерским программам*
limit**
date_start***
date_end***
website***
campaign***
subid***
total****
order_by*****

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

*** Фильтр по датам, площадкам, партнерским программам и SubID соответственно. Например campaign=3&campaign=4&website=8&date_start=01.01.2011, где значения — это идентификаторы фильтруемых категорий или фильтруемые данные. Значения для дат должны быть в формате '%d.%m.%Y' — '01.05.2012'.

**** Параметр, позволяющий получить агрегированные данные по всему запросу. Возможные значения: 1/0 — агрегированные данные/не агрегированный результат.

***** Порядок сортировки. Возможные значения:

  • action
  • clicks
  • cr
  • ctr
  • ecpc
  • ecpm
  • leads
  • name
  • payment_sum
  • payment_sum_approved
  • payment_sum_declined
  • payment_sum_open
  • sales
  • views
    Знак '-' перед значением означает обратный порядок. Например order_by=-clicks&order_by=cr.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/campaigns/?date_start=01.01.2011&limit=1&order_by=-payment_sum&offset=1&total=0

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "leads_sum": 4,  
            "advcampaign_name": "AdvCamp 3",  
            "payment_sum_declined": 0.0,  
            "ctr": 0.0256,  
            "advcampaign_id": 8,  
            "views": 78,  
            "clicks": 2,  
            "payment_sum_approved": 0.0,  
            "currency": "RUB",  
            "ecpm": 7149.871794,  
            "sales_sum": 0,  
            "cr": 2.0,  
            "ecpc": 278.845,  
            "payment_sum_open": 557.69  
        }  
    ],  
    "_meta": {  
        "count": 4,  
        "limit": 1,  
        "offset": 1  
    }  
}

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/campaigns/?date_start=01.01.2011&limit=1&order_by=-payment_sum&offset=1&total=1

Пример ответа API-сервера в формате JSON:

[  
    {  
        "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  
    }  
]

Описание полей ответа API-сервера

НазваниеОписание
advcampaign_nameНазвание партнерской программы
advcampaign_idИдентификатор партнерской программы
currencyСистемные валюты
leads_sumКоличество лидов
sales_sumКоличество продаж
payment_sum_declinedСумма по отклоненным действиям
payment_sum_approvedСумма по подтверждённым действиям
payment_sum_openСумма по открытым действиям
viewsКоличество показов
clicksКоличество кликов
ctrCTR
ecpceCPC
crКонверсия
ecpmeCPM

Статистика по дням

Параметры

HTTP- методПрава доступаURLПараметрыПримечание
GETstatisticshttps://api.admitad.com/statistics/dates/offset **Статистические данные по дням*
limit **
date_start ***
date_end ***
website ***
campaign ***
subid ***
total****
order_by*****

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

*** Фильтр по датам, площадкам, партнерским программам и SubID соответственно. Например, campaign=3&campaign=4&website=8&date_start=01.01.2011, где значения — это идентификаторы фильтруемых категорий или фильтруемые данные. Значения для дат должны быть в формате %d.%m.%Y - 01.05.2012.

**** Параметр, позволяющий получить агрегированные данные по всему запросу. Возможные значения: 1/0 — агрегированные данные/не агрегированный результат.

***** Порядок сортировки. Возможные значения:

  • action
  • clicks
  • cr
  • ctr
  • date
  • ecpc
  • ecpm
  • leads
  • payment_sum
  • payment_sum_approved
  • payment_sum_declined
  • payment_sum_open
  • sales
  • views
    Знак '-' перед значением означает обратный порядок. Например order_by=-clicks&order_by=cr.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/dates/?date_start=01.01.2011&limit=2&order_by=date&offset=1

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "leads_sum": 0,  
            "ctr": 0.0,  
            "views": 0,  
            "payment_sum_declined": 0.0,  
            "clicks": 2,  
            "payment_sum_approved": -1254.81,  
            "currency": "RUB",  
            "ecpm": 0.0,  
            "sales_sum": 4,  
            "sales_sum_approved": 1,  
            "sales_sum_open": 1,  
            "sales_sum_declined": 2,  
            "leads_sum_approved": 1,  
            "leads_sum_open": 2,  
            "leads_sum_declined": 0,  
            "date": "2011-02-24",  
            "cr": 0.0,  
            "ecpc": 2509.615,  
            "payment_sum_open": 6274.04  
        },  
        {  
            "leads_sum": 12,  
            "ctr": 7.0,  
            "views": 1,  
            "payment_sum_declined": 0.0,  
            "clicks": 7,  
            "payment_sum_approved": 0.0,  
            "currency": "RUB",  
            "ecpm": 4350000.0,  
            "sales_sum": 0,  
            "sales_sum_approved": 0,  
            "sales_sum_open": 0,  
            "sales_sum_declined": 0,  
            "leads_sum_approved": 0,  
            "leads_sum_open": 0,  
            "leads_sum_declined": 0,  
            "date": "2011-07-19",  
            "cr": 1.7143,  
            "ecpc": 621.428571,  
            "payment_sum_open": 4350.0  
        }  
    ],  
    "_meta": {  
        "count": 58,  
        "limit": 2,  
        "offset": 1  
    }  
}

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/dates/?date_start=01.01.2011&limit=2&order_by=date&offset=1&total=1

Пример ответа API-сервера в формате JSON:

[  
    {  
        "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  
    }  
]

Описание полей ответа API-сервера

НазваниеОписание
dateДата статистики
currencyСистемные валюты
leads_sumКоличество лидов
sales_sumКоличество продаж
payment_sum_declinedСумма по отклоненным действиям
payment_sum_approvedСумма по подтверждённым действиям
payment_sum_openСумма по открытым действиям
sales_sum_approvedКоличество подтверждённых продаж
sales_sum_openКоличество открытых продаж
sales_sum_declinedКоличество отклоненных продаж
leads_sum_approvedКоличество подтверждённых лидов
leads_sum_openКоличество открытых лидов
leads_sum_declinedКоличество отклоненных лидов
viewsКоличество показов
clicksКоличество кликов
ctrCTR
ecpceCPC
crКонверсия
ecpmeCPM

Статистика по месяцам

Параметры

HTTP- методПрава доступаURLПараметрыПримечание
GETstatisticshttps://api.admitad.com/statistics/months/offset**Статистические данные по месяцам*
limit**
date_start***
date_end***
website***
campaign***
subid***
total****
order_by*****

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

*** Фильтр по датам, площадкам, партнерским программам и SubID соответственно. Например campaign=3&campaign=4&website=8&date_start=01.01.2011, где значения — это идентификаторы фильтруемых категорий или фильтруемые данные. Значения для дат должны быть в формате '%d.%m.%Y' - '01.05.2012'.

**** Параметр, позволяющий получить агрегированные данные по всему запросу. Возможные значения: 1/0 — агрегированные данные/не агрегированный результат.

***** Порядок сортировки. Возможные значения:

  • action
  • clicks
  • cr
  • ctr
  • date
  • ecpc
  • ecpm
  • leads
  • payment_sum
  • payment_sum_approved
  • payment_sum_declined
  • payment_sum_open
  • sales
  • views
    Знак '-' перед значением означает обратный порядок. Например order_by=-clicks&order_by=cr.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/months/?date_start=01.01.2011&limit=2&order_by=date&offset=1

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "leads_sum": 0,  
            "ctr": 0.001,  
            "views": 5153,  
            "payment_sum_declined": 0.0,  
            "clicks": 5,  
            "payment_sum_approved": -1254.81,  
            "currency": "RUB",  
            "ecpm": 1731.626237,  
            "sales_sum": 6,  
            "date": "2011-02",  
            "cr": 1.2,  
            "ecpc": 1784.614,  
            "payment_sum_open": 10177.88  
        },  
        {  
            "leads_sum": 1,  
            "ctr": 9.0,  
            "views": 1,  
            "payment_sum_declined": 0.0,  
            "clicks": 9,  
            "payment_sum_approved": 100.0,  
            "currency": "RUB",  
            "ecpm": 1887020.0,  
            "sales_sum": 2,  
            "date": "2011-03",  
            "cr": 0.5556,  
            "ecpc": 209.668889,  
            "payment_sum_open": 1787.02  
        }  
    ],  
    "_meta": {  
        "count": 15,  
        "limit": 2,  
        "offset": 1  
    }  
}

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/months/?date_start=01.01.2011&limit=2&order_by=date&offset=1&total=1

Пример ответа API-сервера в формате JSON:

[  
    {  
        "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  
    }  
]

Описание полей ответа API-сервера

НазваниеОписание
dateДата статистики
currencyСистемные валюты
leads_sumКоличество лидов
sales_sumКоличество продаж
payment_sum_declinedСумма по отклоненным действиям
payment_sum_approvedСумма по подтверждённым действиям
payment_sum_openСумма по открытым действиям
viewsКоличество показов
clicksКоличество кликов
ctrCTR
ecpceCPC
crКонверсия
ecpmeCPM

Статистика по действиям

Параметры

HTTP- методПрава доступаURLПараметрыПримечание
GETstatisticshttps://api.admitad.com/statistics/actions/offset**Статистические данные по действиям*
limit**
action_id_start***
date_start***
date_end***
closing_date_start***
closing_date_end***
status_updated_start***
status_updated_end***
website***
campaign***
subid***
subid1***
subid2***
subid3***
subid4***
source***
status***
keyword***
action***
action_id***
banner***
action_type***
processed****
paid*****
total******
order_by*******

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

*** Фильтр по датам, площадкам, партнерским программам, SubID, источнику, статусу, ключевым словам, действиям, тарифам, идентификатору действия и типам тарифов соответственно. Например campaign=3&campaign=4&website=8&date_start=01.01.2011, где значения — это идентификаторы фильтруемых категорий или фильтруемые данные. Значения для дат должны быть в формате %d.%m.%Y — 01.05.2012. Значения для дат status_updated_start и status_updated_end должны быть в формате %d.%m.%Y %H:%M:%S — 01.05.2012 21:12:01.

**** Фильтр по состоянию обработки. Возможные значения: 0/1 - не обработан/обработан.

***** Фильтр по cостоянию выплаты средств веб-мастеру. Возможные значения: 0/1 — не выплачены/выплачены.

****** Параметр, позволяющий получить агрегированные данные по всему запросу. Возможные значения: 1/0 - агрегированные данные/не агрегированный результат.

******* Порядок сортировки. Возможные значения:

  • datetime
    Знак '-' перед значением означает обратный порядок. Например order_by=-clicks&order_by=cr.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  
https://api.admitad.com/statistics/actions/  
?date_start=01.01.2011&limit=2&order_by=date&offset=1&action_id=12&total=0

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "status": "pending",  
            "comment": null,  
            "conversion_time": 135,  
            "keyword": null,  
            "advcampaign_name": "AdvCamp 1",  
            "advcampaign_id": 6,  
            "cart": null,  
            "subid": null,  
            "subid1": null,  
            "subid2": null,  
            "subid3": null,  
            "subid4": null,  
            "click_user_referer": null,  
            "currency": "USD",  
            "action_date": "2011-02-22 19:54:34",  
            "website_name": "site1",  
            "action": "action name",  
            "click_date": "2011-02-22 19:52:19",  
            "payment": 70.0,  
            "tariff_id": 11,  
            "banner_id": 131,  
            "action_id": 241,  
            "processed": 1,  
            "paid": 0,  
            "order_id": "999",  
            "closing_date": "2012-04-02",  
            "action_type": "lead",  
            "promocode": "promo500",  
            "status_updated": "2011-09-16 23:13:35",  
            "positions": [  
                {  
                    "tariff_id": 1,  
                    "payment": "12.00",  
                    "rate": null,  
                    "datetime": "2011-02-22 20:12:04",  
                    "amount": "32.00",  
                    "percentage": false,  
                    "product_url": "",  
                    "id": 1  
                },  
                {  
                    "tariff_id": 1,  
                    "payment": "23.00",  
                    "rate": null,  
                    "datetime": "2011-02-22 21:37:14",  
                    "amount": "32.00",  
                    "percentage": false,  
                    "product_url": "",  
                    "id": 2  
                }  
            ]  
        },  
        {  
            "status": "pending",  
            "comment": null,  
            "conversion_time": 844,  
            "keyword": null,  
            "advcampaign_name": "AdvCamp 1",  
            "advcampaign_id": 6,  
            "cart": 90,  
            "subid": null,  
            "subid1": null,  
            "subid2": null,  
            "subid3": null,  
            "subid4": null,  
            "click_user_referer": null,  
            "currency": "USD",  
            "action_date": "2011-02-24 18:58:14",  
            "website_name": "site1",  
            "action": "action name",  
            "click_date": "2011-02-24 18:44:10",  
            "payment": 45.0,  
            "tariff_id": 11,  
            "banner_id": 91,  
            "action_id": 242,  
            "processed": 0,  
            "paid": 0,  
            "order_id": "998",  
            "action_type": "sale",  
            "promocode": "promo500",  
            "closing_date": "2012-04-02",  
            "status_updated": "2011-09-16 23:08:31",  
            "positions": [  
                {  
                    "tariff_id": 1,  
                    "payment": "12.00",  
                    "rate": null,  
                    "datetime": "2011-02-24 21:41:01",  
                    "amount": "32.00",  
                    "percentage": false,  
                    "product_url": "http://example.com/test/product/url",  
                    "id": 3  
                },  
                {  
                    "tariff_id": 1,  
                    "payment": "12.00",  
                    "rate": null,  
                    "datetime": "2011-02-24 22:22:47",  
                    "amount": "32.00",  
                    "percentage": false,  
                    "product_url": "http://example.com/test/product/url"  
                    "id": 4  
                }  
            ]  
        }  
    ],  
    "_meta": {  
        "count": 55,  
        "limit": 2,  
        "offset": 1  
    }  
}

Пример запроса с использованием утилиты curl:

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

Пример ответа API-сервера в формате JSON:

[  
    {  
        "currency": "RUB"  
        "payment_sum": 1462248.20,  
        "cart": 1640014.39  
    },  
    {  
        "currency": "USD"  
        "payment_sum": 1470220.86,  
        "cart": 1654822.73  
    },  
    {  
        "currency": "EUR"  
        "payment_sum": 1463807.20,  
        "cart": 1638854.84  
    }  
]

Описание полей ответа API-сервера

НазваниеОписание
action_idИдентификатор заявки
advcampaign_nameНазвание партнерской программы
advcampaign_idИдентификатор партнерской программы
website_nameНазвание площадки
statusСтатус (pending/approved/declined/approved_but_stalled — в ожидании/подтверждён/отклонён/подтвержден, но задержан). «Подтверждён, но задержан» означает, что у рекламодателя на счету на текущий момент недостаточно средств для оплаты.
commentКомментарий
action_dateДата действия
action_typeТип действия (‘lead, ‘sale’)
promocodeЗначение промокода, по которому было зарегистрировано действие.
paymentСумма платежа
actionНазвание тарифа
tariff_idИдентификатор тарифа
currencyСистемные валюты
conversion_timeВремя конверсии
keywordКлючевое слово
cartСумма заказа
subid(1-4)SubID
click_dateВремя клика
click_user_refererРеферер клика
click_country_codeКод страны, где был зарегистрирован клик
banner_idID баннера
closing_dateФактическая дата обработки действия
status_updatedДата и время последнего изменения статуса действия
processedCостояние обработки — Да/Нет(1/0). «Обработан» при статусе «Подтверждён» означает, что деньги зачислены на счет веб-мастера.
paidСостояние выплаты средств веб-мастеру — Да/Нет(1/0). Поле показывает, были ли выведены средства за конкретный заказ из Admitad в Earnings.
order_idНомер заказа на стороне рекламодателя
positionsПозиции заказа

Описание полей позиций заказов

НазваниеОписание
idИдентификатор позиции
tariff_idИдентификатор тарифа
datetimeДата и время регистрации позиции
amountСумма действия (price * quantity)
paymentОплата веб-мастеру
rateСтавка
product_urlСсылка на купленный товар
product_idИдентификатор товара
product_nameНазвание товара
product_imageСсылка на изображение товара
percentage«Процентность» ставки (True, если ставка процентная)

Описание полей total запроса

НазваниеОписание
currencyСистемные валюты
payment_sumСумма действий
cartСумма заказов

Статистика по subID

Параметры

HTTP- методПрава доступаURLПараметрыПримечание
GETstatisticshttps://api.admitad.com/statistics/sub_ids/offset**Статистические данные по subID*
limit**
date_start**
date_end***
website***
campaign***
subid****
order_by*****
total******
group_subids*******

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

*** Фильтр по датам, площадкам и партнерским программам соответственно. Например campaign=3&campaign=4&website=8&date_start=01.01.2011, где значения — это идентификаторы фильтруемых категорий или фильтруемые данные. Значения для дат должны быть в формате '%d.%m.%Y' - '01.05.2012'.

**** Фильтры по subid, subid1, subid2, subid3, subid4. Могут принимать значения соотверствующие URL. Например subid=a&subid2=b.

***** Порядок сортировки. Возможные значения:

  • actions
  • clicks
  • cr
  • ecpc
  • leads
  • payment_sum
  • payment_sum_approved
  • payment_sum_declined
  • payment_sum_open
  • sales
  • subid (subid1, subid2, subid3, subid4 — для соответствующего URL)
    Знак '-' перед значением означает обратный порядок. Например order_by=-clicks&order_by=cr.

****** Параметр, позволяющий получить агрегированные данные по всему запросу. Возможные значения: 1/0 — агрегированные данные/не агрегированный результат.

******* group_subids - условие группировки, по умолчанию группировка статистики осуществляется по subid, однако можно указать другие значения из набора subid, subid1, subid2, subid3, subid4 Например group_subids=subid3.

Пример использования

Пример запроса с использованием утилиты curl:

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

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "leads_sum": 37,  
            "payment_sum_approved": 0.0,  
            "currency": "RUB",  
            "payment_sum_declined": 0.0,  
            "payment_sum_open": 26453.35,  
            "subid": "",  
            "sales_sum": 9,  
            "cr": 0.0,  
            "ecpc": 1556.079412,  
            "clicks": 17  
        },  
        {  
            "leads_sum": 4,  
            "payment_sum_approved": 0.0,  
            "currency": "RUB",  
            "payment_sum_declined": 0.0,  
            "payment_sum_open": 4238.46,  
            "subid": "testsubid",  
            "sales_sum": 1,  
            "cr": 0.0,  
            "ecpc": 0.0,  
            "clicks": 0  
        }  
    ],  
    "_meta": {  
        "count": 14,  
        "limit": 2,  
        "offset": 0  
    }  
}

Пример запроса с использованием утилиты curl:

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

Пример ответа API-сервера в формате JSON:

[  
    {  
        "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,  
        "cr": 311.76,  
        "ecpc": 0.48,  
        "clicks": 7064253  
    }  
]

Описание полей ответа API-сервера

НазваниеОписание
subidSubID (при группировке по subid)
subid1SubID1 (только при группировке по subid1)
subid2SubID2 (только при группировке по subid2)
subid3SubID3 (только при группировке по subid3)
subid4SubID4 (только при группировке по subid4)
currencyСистемные валюты
leads_sumКоличество лидов
sales_sumКоличество продаж
payment_sum_declinedСумма по отклоненным действиям
payment_sum_approvedСумма по подтверждённым действиям
payment_sum_openСумма по открытым действиям
clicksКоличество кликов
ecpceCPC
crКонверсия

Статистика по источникам

Параметры

HTTP- методПрава доступаURLПараметрыПримечание
GETstatisticshttps://api.admitad.com/statistics/sources/offset**Статистические данные по источникам*
limit**
date_start***
date_end***
website***
campaign***
total****
order_by*****

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.

*** Фильтр по датам, площадкам и партнерским программам соответственно. Например campaign=3&campaign=4&website=8&date_start=01.01.2011, где значения — это идентификаторы фильтруемых категорий или фильтруемые данные. Значения для дат должны быть в формате '%d.%m.%Y' - '01.05.2012'.

**** Параметр, позволяющий получить агрегированные данные по всему запросу. Возможные значения: 1/0 — агрегированные данные/не агрегированный результат.

***** Порядок сортировки. Возможные значения:

  • actions
  • clicks
  • cr
  • ecpc
  • leads
  • payment_sum
  • payment_sum_approved
  • payment_sum_declined
  • payment_sum_open
  • sales
  • source
    Знак '-' перед значением означает обратный порядок. Например order_by=-clicks&order_by=cr.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/sources/?date_start=01.01.2011&limit=2&order_by=-payment_sum

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "leads_sum": 1,  
            "source_name": "Google Adwords",  
            "sales_sum": 0,  
            "payment_sum_declined": 0.0,  
            "clicks": 7,  
            "payment_sum_approved": 0.0,  
            "currency": "RUB",  
            "source": "g",  
            "cr": 0.0,  
            "ecpc": 51.785714,  
            "payment_sum_open": 362.5  
        },  
        {  
            "leads_sum": 0,  
            "source_name": "Yandex.Direct",  
            "sales_sum": 0,  
            "payment_sum_declined": 0.0,  
            "clicks": 1,  
            "payment_sum_approved": 0.0,  
            "currency": "RUB",  
            "source": "y",  
            "cr": 0.0,  
            "ecpc": 0.0,  
            "payment_sum_open": 0.0  
        }  
    ],  
    "_meta": {  
        "count": 2,  
        "limit": 2,  
        "offset": 0  
    }  
}

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/sources/?date_start=01.01.2011&limit=2&order_by=-payment_sum&total=1

Пример ответа API-сервера в формате JSON:

[  
    {  
        "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  
    }  
]

Описание полей ответа API-сервера

НазваниеОписание
source_nameПолное название источника
sourceКод источника
currencyСистемные валюты
leads_sumКоличество лидов
sales_sumКоличество продаж
payment_sum_declinedСумма по отклоненным действиям
payment_sum_approvedСумма по подтверждённым действиям
payment_sum_openСумма по открытым действиям
clicksКоличество кликов
ecpceCPC
crКонверсия

Статистика по ключевым словам

Параметры

HTTP- методПрава доступаURLПараметрыПримечание
GETstatisticshttps://api.admitad.com/statistics/keywords/offset**Статистические данные по ключевым словам*
limit**
date_start***
date_end***
website***
campaign***
source***
total****
order_by*****

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.

*** Фильтр по датам, площадкам, партнерским программам и источникам соответственно. Например campaign=3&campaign=4&website=8&date_start=01.01.2011, где значения — это идентификаторы фильтруемых категорий или фильтруемые данные. Значения для дат должны быть в формате '%d.%m.%Y' - '01.05.2012'.

**** Параметр, позволяющий получить агрегированные данные по всему запросу. Возможные значения: 1/0 - агрегированные данные/не агрегированный результат.

***** Порядок сортировки. Возможные значения:

  • actions
  • clicks
  • cr
  • ecpc
  • keyword
  • leads
  • payment_sum
  • payment_sum_approved
  • payment_sum_declined
  • payment_sum_open
  • sales
    Знак '-' перед значением означает обратный порядок. Например order_by=-clicks&order_by=cr.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/keywords/?date_start=01.01.2011&limit=2&order_by=-payment_sum

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "leads_sum": 1,  
            "keyword": "test",  
            "currency": "EUR",  
            "payment_sum_declined": 0.0,  
            "payment_sum_open": 8.97,  
            "payment_sum_approved": 0.0,  
            "sales_sum": 0,  
            "cr": 0.0,  
            "ecpc": 1.794,  
            "clicks": 5  
        },  
        {  
            "leads_sum": 0,  
            "keyword": "ept",  
            "currency": "EUR",  
            "payment_sum_declined": 0.0,  
            "payment_sum_open": 0.0,  
            "payment_sum_approved": 0.0,  
            "sales_sum": 0,  
            "cr": 0.0,  
            "ecpc": 0.0,  
            "clicks": 1  
        }  
    ],  
    "_meta": {  
        "count": 3,  
        "limit": 2,  
        "offset": 0  
    }  
}

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/statistics/keywords/?date_start=01.01.2011&limit=2&order_by=-payment_sum&total=1

Пример ответа API-сервера в формате JSON:

[  
    {  
        "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  
    }  
]

Описание полей ответа API-сервера

НазваниеОписание
keywordКлючевое слово
currencyСистемные валюты
leads_sumКоличество лидов
sales_sumКоличество продаж
payment_sum_declinedСумма по отклоненным действиям
payment_sum_approvedСумма по подтверждённым действиям
payment_sum_openСумма по открытым действиям
clicksКоличество кликов
ecpceCPC
crКонверсия