# Статистика веб-мастера
# Статистика по площадкам
## Параметры
| HTTP- метод | Права доступа | URL | Параметры | Примечание |
| ----------- | ---------------------------------------- | -------------------------------------------- | ------------------- | ------------------------------------ |
| GET | [statistics](/article/ru/308#statistics) | https://api.admitad.com/statistics/websites/ | offset\*\* | Статистические данные по площадкам\* |
| | | | limit\*\* | |
| | | | date\_start\*\*\* | |
| | | | date\_end\*\*\* | |
| | | | website\*\*\* | |
| | | | campaign\*\*\* | |
| | | | subid \*\*\* | |
| | | | total\*\*\*\* | |
| | | | order\_by\*\*\*\*\* | |
\* Возвращает результат в формате JSON.
*\** Задаёт пропуск и количество возвращаемых записей. Например [limit\=5\&offset\=2](/article/ru/310)
\*\*\* Фильтр по датам, площадкам, партнерским программам и 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 | [Системные валюты](/article/ru/316#system-currencies) |
| leads\_sum | Количество лидов |
| sales\_sum | Количество продаж |
| payment\_sum\_declined | Сумма по отклоненным действиям |
| payment\_sum\_approved | Сумма по подтверждённым действиям |
| payment\_sum\_open | Сумма по открытым действиям |
| views | Количество показов |
| clicks | Количество кликов |
| ctr | CTR |
| ecpc | eCPC |
| cr | Конверсия |
| ecpm | eCPM |
# Статистика по партнерским программам
## Параметры
| HTTP- метод | Права доступа | URL | Параметры | Примечание |
| ----------- | ---------------------------------------- | --------------------------------------------- | ------------------- | ------------------------------------------------- |
| GET | [statistics](/article/ru/308#statistics) | https://api.admitad.com/statistics/campaigns/ | offset\*\* | Статистические данные по партнерским программам\* |
| | | | limit\*\* | |
| | | | date\_start\*\*\* | |
| | | | date\_end\*\*\* | |
| | | | website\*\*\* | |
| | | | campaign\*\*\* | |
| | | | subid\*\*\* | |
| | | | total\*\*\*\* | |
| | | | order\_by\*\*\*\*\* | |
\* Возвращает результат в формате JSON.
\*\* Задаёт пропуск и количество возвращаемых записей. Например [limit\=5\&offset\=2](/article/ru/310)
\*\*\* Фильтр по датам, площадкам, партнерским программам и 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 | [Системные валюты](/article/ru/316#system-currencies) |
| leads\_sum | Количество лидов |
| sales\_sum | Количество продаж |
| payment\_sum\_declined | Сумма по отклоненным действиям |
| payment\_sum\_approved | Сумма по подтверждённым действиям |
| payment\_sum\_open | Сумма по открытым действиям |
| views | Количество показов |
| clicks | Количество кликов |
| ctr | CTR |
| ecpc | eCPC |
| cr | Конверсия |
| ecpm | eCPM |
# Статистика по дням
## Параметры
| HTTP- метод | Права доступа | URL | Параметры | Примечание |
| ----------- | ---------------------------------------- | ----------------------------------------- | ------------------- | ------------------------------- |
| GET | [statistics](/article/ru/308#statistics) | https://api.admitad.com/statistics/dates/ | offset \*\* | Статистические данные по дням\* |
| | | | limit \*\* | |
| | | | date\_start \*\*\* | |
| | | | date\_end \*\*\* | |
| | | | website \*\*\* | |
| | | | campaign \*\*\* | |
| | | | subid \*\*\* | |
| | | | total\*\*\*\* | |
| | | | order\_by\*\*\*\*\* | |
\* Возвращает результат в формате JSON.
\*\* Задаёт пропуск и количество возвращаемых записей. Например [*limit\=5\&offset\=2*](/article/ru/310)
\*\*\* Фильтр по датам, площадкам, партнерским программам и 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 | [Системные валюты](/article/ru/316#system-currencies) |
| 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 | Количество кликов |
| ctr | CTR |
| ecpc | eCPC |
| cr | Конверсия |
| ecpm | eCPM |
# Статистика по месяцам
## Параметры
| HTTP- метод | Права доступа | URL | Параметры | Примечание |
| ----------- | ---------------------------------------- | ------------------------------------------ | ------------------- | ---------------------------------- |
| GET | [statistics](/article/ru/308#statistics) | https://api.admitad.com/statistics/months/ | offset\*\* | Статистические данные по месяцам\* |
| | | | limit\*\* | |
| | | | date\_start\*\*\* | |
| | | | date\_end\*\*\* | |
| | | | website\*\*\* | |
| | | | campaign\*\*\* | |
| | | | subid\*\*\* | |
| | | | total\*\*\*\* | |
| | | | order\_by\*\*\*\*\* | |
\* Возвращает результат в формате JSON.
\*\* Задаёт пропуск и количество возвращаемых записей. Например [limit\=5\&offset\=2](/article/ru/310)
\*\*\* Фильтр по датам, площадкам, партнерским программам и 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 | [Системные валюты](/article/ru/316#system-currencies) |
| leads\_sum | Количество лидов |
| sales\_sum | Количество продаж |
| payment\_sum\_declined | Сумма по отклоненным действиям |
| payment\_sum\_approved | Сумма по подтверждённым действиям |
| payment\_sum\_open | Сумма по открытым действиям |
| views | Количество показов |
| clicks | Количество кликов |
| ctr | CTR |
| ecpc | eCPC |
| cr | Конверсия |
| ecpm | eCPM |
## Статистика по действиям
### Параметры
| HTTP- метод | Права доступа | URL | Параметры | Примечание |
| ----------- | ---------------------------------------- | ------------------------------------------- | ---------------------------- | ------------------------------------ |
| GET | [statistics](/article/ru/308#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](/article/ru/310)
\*\*\* Фильтр по датам, площадкам, партнерским программам, 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,
"payouts_ids_from_adpay": [1, 2, 3],
"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,
"payouts_ids_from_adpay": [1, 2, 3],
"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 | [Системные валюты](/article/ru/316#system-currencies) |
| 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). Поле показывает, были ли выведены средства за конкретный заказ из Earnings на счет веб-мастера. |
| payouts\_ids\_from\_adpay | Массив идентификаторов выплат. Поле показывает ID выплат, по которым перечислены деньги за заказ. |
| order\_id | Номер заказа на стороне рекламодателя |
| positions | Позиции заказа |
## Описание полей позиций заказов
| Название | Описание |
| -------------- | ---------------------------------------------------- |
| id | Идентификатор позиции |
| tariff\_id | Идентификатор тарифа |
| datetime | Дата и время регистрации позиции |
| amount | Сумма действия (price \* quantity) |
| payment | Оплата веб-мастеру |
| rate | Ставка |
| product\_url | Ссылка на купленный товар |
| product\_id | Идентификатор товара |
| product\_name | Название товара |
| product\_image | Ссылка на изображение товара |
| percentage | «Процентность» ставки (True, если ставка процентная) |
## Описание полей total запроса
| Название | Описание |
| ------------ | ----------------------------------------------------- |
| currency | [Системные валюты](/article/ru/316#system-currencies) |
| payment\_sum | Сумма действий |
| cart | Сумма заказов |
# Статистика по subID
## Параметры
| HTTP- метод | Права доступа | URL | Параметры | Примечание |
| ----------- | ---------------------------------------- | -------------------------------------------- | --------------------------- | -------------------------------- |
| GET | [statistics](/article/ru/308#statistics) | https://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](/article/ru/310)
\*\*\* Фильтр по датам, площадкам и партнерским программам соответственно. Например 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 | [Системные валюты](/article/ru/316#system-currencies) |
| leads\_sum | Количество лидов |
| sales\_sum | Количество продаж |
| payment\_sum\_declined | Сумма по отклоненным действиям |
| payment\_sum\_approved | Сумма по подтверждённым действиям |
| payment\_sum\_open | Сумма по открытым действиям |
| clicks | Количество кликов |
| ecpc | eCPC |
| cr | Конверсия |
# Статистика по источникам
## Параметры
| HTTP- метод | Права доступа | URL | Параметры | Примечание |
| ----------- | ---------------------------------------- | ------------------------------------------- | ------------------- | ------------------------------------- |
| GET | [statistics](/article/ru/308#statistics) | https://api.admitad.com/statistics/sources/ | offset\*\* | Статистические данные по источникам\* |
| | | | limit\*\* | |
| | | | date\_start\*\*\* | |
| | | | date\_end\*\*\* | |
| | | | website\*\*\* | |
| | | | campaign\*\*\* | |
| | | | total\*\*\*\* | |
| | | | order\_by\*\*\*\*\* | |
\* Возвращает результат в формате JSON.
\*\* Задаёт пропуск и количество возвращаемых записей. Например [limit\=5\&offset\=2](/article/ru/310).
\*\*\* Фильтр по датам, площадкам и партнерским программам соответственно. Например 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 | [Системные валюты](/article/ru/316#system-currencies) |
| leads\_sum | Количество лидов |
| sales\_sum | Количество продаж |
| payment\_sum\_declined | Сумма по отклоненным действиям |
| payment\_sum\_approved | Сумма по подтверждённым действиям |
| payment\_sum\_open | Сумма по открытым действиям |
| clicks | Количество кликов |
| ecpc | eCPC |
| cr | Конверсия |
# Статистика по ключевым словам
## Параметры
| HTTP- метод | Права доступа | URL | Параметры | Примечание |
| ----------- | ---------------------------------------- | -------------------------------------------- | ------------------- | ------------------------------------------ |
| GET | [statistics](/article/ru/308#statistics) | https://api.admitad.com/statistics/keywords/ | offset\*\* | Статистические данные по ключевым словам\* |
| | | | limit\*\* | |
| | | | date\_start\*\*\* | |
| | | | date\_end\*\*\* | |
| | | | website\*\*\* | |
| | | | campaign\*\*\* | |
| | | | source\*\*\* | |
| | | | total\*\*\*\* | |
| | | | order\_by\*\*\*\*\* | |
\* Возвращает результат в формате JSON.
\*\* Задаёт пропуск и количество возвращаемых записей. Например [limit\=5\&offset\=2](/article/ru/310).
\*\*\* Фильтр по датам, площадкам, партнерским программам и источникам соответственно. Например 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 | [Системные валюты](/article/ru/316#system-currencies) |
| leads\_sum | Количество лидов |
| sales\_sum | Количество продаж |
| payment\_sum\_declined | Сумма по отклоненным действиям |
| payment\_sum\_approved | Сумма по подтверждённым действиям |
| payment\_sum\_open | Сумма по открытым действиям |
| clicks | Количество кликов |
| ecpc | eCPC |
| cr | Конверсия |