Статистика по ключевым словам

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET statistics https://api.admitad.com/statistics/keywords/
  • offset **
  • limit **
  • date_start ***
  • date_end ***
  • website ***
  • campaign ***
  • source ***
  • total****
  • order_by *****
Статистические данные по ключевым словам.*
  • * Возвращает результат в формате JSON.

  • ** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.

  • *** Фильтр по датам, площадкам, рекламным программам и источникам соответственно. Например 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 Системные валюты
leads_sum Количество лидов
sales_sum Количество продаж
payment_sum_declined Сумма по отклоненным действиям
payment_sum_approved Сумма по подтверждённым действиям
payment_sum_open Сумма по открытым действиям
clicks Количество кликов
ecpc eCPC
cr Конверсия