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

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET statistics https://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 - агрегированные данные/не агрегированный результат

  • ***** Порядок сортировки. Возможные значения:
    • 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/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.714285,
            "sales_sum": 1,
            "cr": 0.0015,
            "ecpc": 0.627177,
            "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
    }
]

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

Название Описание
website_name Название площадки
website_id Идентификатор площадки
currency Системные валюты
leads_sum Количество лидов
sales_sum Количество продаж
payment_sum_declined Сумма по отклоненным действиям
payment_sum_approved Сумма по подтверждённым действиям
payment_sum_open Сумма по открытым действиям
views Количество показов
clicks Количество кликов
ctr CTR
ecpc eCPC
cr Конверсия
ecpm eCPM