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

Параметры¶

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	statistics	`https://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",
            "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",
            "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’)
payment	Сумма платежа
action	Название тарифа
tariff_id	Идентификатор тарифа
currency	Системные валюты
conversion_time	Время конверсии
keyword	Ключевое слово
cart	Сумма заказа
subid(1-4)	SubID
click_date	Время клика
click_user_referer	Реферер клика
click_country_code	Код страны, где был зарегистрирован клик
banner_id	ID баннера
closing_date	Фактическая дата обработки действия
status_updated	Дата и время последнего изменения статуса действия
processed	Cостояние обработки - Да/Нет(1/0). “Обработан” при статусе “Подтверждён” означает, что деньги зачислены на счет веб-мастера.
paid	Состояние выплаты средств веб-мастеру — Да/Нет(1/0).
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	Сумма заказов