Статистика по subID¶
Параметры¶
HTTP метод | Права доступа | URL | Параметры | Примечание |
---|---|---|---|---|
GET | statistics | https://api.admitad.com/statistics/sub_ids/ |
|
Статистические данные по subID.* |
* Возвращает результат в формате 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-сервера¶
Название | Описание |
---|---|
subid | SubID (при группировке по subid) |
subid1 | SubID1 (только при группировке по subid1) |
subid2 | SubID2 (только при группировке по subid2) |
subid3 | SubID3 (только при группировке по subid3) |
subid4 | SubID4 (только при группировке по subid4) |
currency | Системные валюты |
leads_sum | Количество лидов |
sales_sum | Количество продаж |
payment_sum_declined | Сумма по отклоненным действиям |
payment_sum_approved | Сумма по подтверждённым действиям |
payment_sum_open | Сумма по открытым действиям |
clicks | Количество кликов |
ecpc | eCPC |
cr | Конверсия |