Reporting API: Статистика


Метрики статистики

Все методы статистики по партнёрским площадкам и группам площадок отдают набор метрик, полностью или частично включающих:

  • shows - количество показов объявлений на площадке
  • clicks - количество кликов по объявлению на площадке
  • requests - количество запросов для площадки
  • requested_banners - общее количество баннеров, запрошенных для площадки. В одном запросе может быть запрошено более 1 баннера.
  • responses - количество баннеров, подобранных на запросы
  • noshows - количество запрашиваемых баннеров, для которых не было подобрано объявление
  • fill_rate - заполняемость: отношение подобранных баннеров к общему количеству запрошеных баннеров
  • amount - сумма начислений за показы объявлений
  • cpm - средняя стоимость показа одного объявления на площадке
  • ctr - процент показов, которые привели к клику по объявлению

Получение статистики по партнёрским площадкам

GET {host}/api/v2/statistics/partner/pads/day.json
Ресурс возвращает статистику по площадкам и группам площадок в разрешении 1 день.

Ограничения и фильтры задаются с помощью GET-параметров:
Параметр
Формат
Описание
date_from
YYYY-MM-DD
Начальная дата
date_to
YYYY-MM-DD
Конечная дата (включительно)
id
список идентификаторов, разделенных запятой
Список идентификаторов площадок или групп площадок.

Вы можете получить список объектов с помощью API или найти object id (pad или group_pad id) в адресной строке браузера. Например:

  • https://target.my.com/pads/13200/ – pad id 13200
  • https://target.my.com/group_pads/4700 – group_pad 4700
Все параметры являются обязательными.

Вы можете запросить статистику не более чем за 92 дня и не более чем по 200 объектам в одном запросе.

Структура ответа:

  • items - массив статистики за запрашиваемый период
    • id - идентификатор объекта. Можно запрашивать статистику как по отдельным площадкам, так и по группам, в том числе в одном запросе.
    • rows - массив статистики с разбивкой по датам
    • total - суммарная статистика по объекту за весь запрашиваемый период
  • total - суммарная статистика по всем объектам за весь запрашиваемый период
Пример запроса:
GET https://target.my.com/api/v2/statistics/partner/pads/day.json?id=3359&date_from=2017-09-20&date_to=2017-09-21
Пример ответа:
{
    "items": [{
        "id": 3359,
        "rows": [{
            "date": "2017-09-20",
            "shows": 6412,
            "clicks": 48,
            "goals": 0,
            "custom": 0,
            "requests": 22126,
            "requested_banners": 22126,
            "responses": 19897,
            "noshows": 2229,
            "amount": "107.98",
            "cpm": "16.84",
            "ctr": 0.7485963817841547,
            "fill_rate": 89.92587905631385
        },
        {
            "date": "2017-09-21",
            "shows": 6426,
            "clicks": 47,
            "goals": 1,
            "custom": 0,
            "requests": 21313,
            "requested_banners": 21313,
            "responses": 18859,
            "noshows": 2454,
            "amount": "108.15",
            "cpm": "16.83",
            "ctr": 0.7314036725801432,
            "fill_rate": 88.48590062403228
        }],
        "total": {
            "shows": 12838,
            "clicks": 95,
            "goals": 1,
            "custom": 0,
            "requests": 43439,
            "requested_banners": 43439,
            "responses": 38756,
            "noshows": 4683,
            "amount": "216.14",
            "cpm": "16.84",
            "ctr": 0.7399906527496495,
            "fill_rate": 89.21936508667326
        }
    }],
    "total": {
        "shows": 12838,
        "clicks": 95,
        "goals": 1,
        "custom": 0,
        "requests": 43439,
        "requested_banners": 43439,
        "responses": 38756,
        "noshows": 4683,
        "amount": "216.14",
        "cpm": "16.84",
        "ctr": 0.7399906527496495,
        "fill_rate": 89.21936508667326
    }
}

Получение статистики по сайтам площадок

GET {host}/api/v2/statistics/pad_with_sites/day.json
Ресурс возвращает статистику по сайтам площадок в разрешении 1 день.

Ограничения и фильтры задаются с помощью GET-параметров:
Параметр
Формат
Описание
date_from
YYYY-MM-DD
Начальная дата
date_to
YYYY-MM-DD
Конечная дата (включительно)
pads
список идентификаторов, разделенных запятой
Список идентификаторов площадок.

Вы можете получить список объектов с помощью API или найти object id (pad или group_pad id) в адресной строке браузера. Например:

  • https://target.my.com/pads/13200/ – pad id 13200
  • https://target.my.com/group_pads/4700 – group_pad 4700
Все параметры являются обязательными.

Получение статистики по площадкам с разбивкой по гео

GET {host}/api/v2/statistics/geo/pads/{hour|day|summary}.json
Метод позволяет получать статистику по площадкам с разбивкой по географическим регионам и времени (hour - по часам, day - по дням, summary - суммарно).

Ограничения и фильтры задаются с помощью GET-параметров:
Параметр
Формат
Описание
date_from
YYYY-MM-DD
Начальная дата
date_to
YYYY-MM-DD
Конечная дата (включительно)
id
список идентификаторов, разделенных запятой
Список идентификаторов площадок

Вы можете получить список объектов с помощью API или найти object id (pad или group_pad id) в адресной строке браузера. Например:

  • https://target.my.com/pads/13200/ – pad id 13200
  • https://target.my.com/group_pads/4700 – group_pad 4700
level
строка
Уровень детализации. Значения:
  • country - разбиение по странам;
  • region - по регионам стран.
Значение по умолчанию - country.
region
идентификатор региона
Идентификатор региона. Ограничивает статистику только по указанному региону и его дочерним регионам.
Параметры date_from, date_to и id являются обязательными.

Получить список всех регионов можно с помощью метода https://target.my.com/api/v2/regions.json.

Структура ответа:

  • items - массив статистики за запрашиваемый период
    • id - идентификатор объекта
    • rows - массив статистики с разбивкой по датам. Включает массив histogram - разбивку по географическим регионам, чьи идентификаторы указаны в поле geo
    • total - суммарная статистика по объекту за весь запрашиваемый период с разбивкой по географическим регионам
  • total - суммарная статистика по всем объектам за весь запрашиваемый период с разбивкой по географическим регионам

Пример запроса:
GET https://target.my.com/api/v2/statistics/geo/pads/day.json?date_from=2017-10-01&date_to=2017-10-12&id=571843
Пример ответа:
{
    
    "items": [{
        "id": 7695,
        "rows": [{
            "date": "2017-12-20",
            "histogram": [{
                "geo": 188,
                "clicks": 0,
                "shows": 697,
                "goals": 0,
                "noshows": 1,
                "requests": 2390,
                "requested_banners": 2390,
                "responsed_blocks": 2389,
                "responsed_banners": 2389,
                "amount": "4.08"
            },
            ...
            {
                "geo": 191,
                "clicks": 0,
                "shows": 5,
                "goals": 0,
                "noshows": 50,
                "requests": 58,
                "requested_banners": 58,
                "responsed_blocks": 10,
                "responsed_banners": 10,
                "amount": "0"
            }]
        },
        {
            "date": "2017-12-21",
            "histogram": [{
                "geo": 188,
                "clicks": 0,
                "shows": 520,
                "goals": 0,
                "noshows": 1,
                "requests": 1888,
                "requested_banners": 1888,
                "responsed_blocks": 1887,
                "responsed_banners": 1887,
                "amount": "2.57"
            },
            ...
            {
                "geo": 191,
                "clicks": 0,
                "shows": 6,
                "goals": 0,
                "noshows": 64,
                "requests": 88,
                "requested_banners": 88,
                "responsed_blocks": 25,
                "responsed_banners": 25,
                "amount": "0"
            }]
        }],
        "total": {
            "histogram": [{
                "geo": 188,
                "clicks": 0,
                "shows": 1217,
                "goals": 0,
                "noshows": 2,
                "requests": 4278,
                "requested_banners": 4278,
                "responsed_blocks": 4276,
                "responsed_banners": 4276,
                "amount": "6.65"
            },
            ...
            {
                "geo": 191,
                "clicks": 0,
                "shows": 11,
                "goals": 0,
                "noshows": 114,
                "requests": 146,
                "requested_banners": 146,
                "responsed_blocks": 35,
                "responsed_banners": 35,
                "amount": "0"
            }]
        }
    }],
    "total": {
        "histogram": [{
            "geo": 188,
            "clicks": 0,
            "shows": 1217,
            "goals": 0,
            "noshows": 2,
            "requests": 4278,
            "requested_banners": 4278,
            "responsed_blocks": 4276,
            "responsed_banners": 4276,
            "amount": "6.65"
        },
        ...
        {
            "geo": 191,
            "clicks": 0,
            "shows": 11,
            "goals": 0,
            "noshows": 114,
            "requests": 146,
            "requested_banners": 146,
            "responsed_blocks": 35,
            "responsed_banners": 35,
            "amount": "0"
        }]
    }
}
Вам помогла эта статья?
Да
Нет