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

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET statistics https://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 Количество кликов
ctr CTR
ecpc eCPC
cr Конверсия
ecpm eCPM