API трекера

Общие замечания

API предназначен для получения данных трекера из сторонних скриптов. Все запросы по API осуществляются к серверу, на котором установлен трекер. Запросы осуществляются по протоколу HTTP с использованием GET-параметров. Результат запроса выдается в форматах JSON и CSV.

Индивидуальный ключ API (и ID клиента для облачной версии) можно получить на странице API.

tracker-domain.com - ваш домен трекера. Для self-hosted версии это тот домен, на который установлен трекер, либо любой из припаркованных доменов. Для облачной версии это домен octotracker-clients.net или любой из ваших припаркованных доменов.

API доступен в трекере начиная с версии 04.16. Некоторые разделы API появились в более поздних версиях - это указано в описании раздела. В облачной версии всегда установлена последняя версия трекера.

Получение статистики

Доступно начиная с версии 04.16. Функционал статистики в API полностью аналогичен разделу Анализ.

Пример запроса

http://tracker-domain.com/pages/uni_get.php?client_id=1234567890&api_key=4d8c70f89c5784b5b50db51de03ec789&api=json&date_from=2017.02.01&date_to=2017.02.28&sid=18&srid=7,3,4&currency=RUB&group1=site&group2=sid1&filter1type=ad&filter1val=7&bl=site

Пояснение к примеру: запрос отчета в формате JSON с 01.02.2017 по 28.02.2017 по одной кампании ID 18 и трем источникам ID 7,3,4 в валюте "Рубли" с группировкой по сайтам и sid1 с фильтром по одному объявлению ID 7 и с применением блек-листа по сайтам.

Формат запроса

(*) Возможные значения параметров группировки:

• Основная группа
  • date - дата
  • site - сайт
  • ad - объявление
  • land - преленд
  • sid1 - дополнительный параметр sid1
  • sid2 - дополнительный параметр sid2
  • sid3 - дополнительный параметр sid3
  • sid4 - дополнительный параметр sid4
  • sid5 - дополнительный параметр sid5
  • country - страна
  • platform - платформа
  • mobtype - тип устройства (дескто/мобильный/планшет)
  • pp - партнерка
  • out - поток ТДС2
  • source - источник трафика
  • campaign - кампания
• Дополнительная группа 1
  • weekday - день недели
  • hour - время суток, с шагом в час
• Дополнительная группа 2
  • os - операционная система
  • osver - операционная система с версией
  • browser - браузер
  • browserver - браузер с версией
  • device - производитель мобильного устройства
  • devicemodel - производитель и модель мобильного устройства
  • carrier - оператор сотовой связи
  • screen - размер экрана
• Дополнительная группа 3
  • city - город
  • region - регион
• Дополнительная группа 4
  • ip - IP адрес

Важно!!! При использовании нескольких параметров группировки в одном отчете нужно понимать, что не все они сочетаются между собой. При этом действуют следующие правила:

• Все параметры из основной группы можно использовать с любыми другими параметрами. Как из основной группы так и из любой дополнительной.
• Параметры из каждой дополнильной группы можно использовать ТОЛЬКО с параметрам из ТОЙ ЖЕ дополнительной ГРУППЫ и из основной группы и нельзя использовать одновременно с параметрами из других дополнительных групп.

Пример ответа

{"rows":[{"group1":"site1.ru", "group2":"12", "group3":"", "clicks":216, "clicks_percent":13.04347826087, "unique":213, "unique_percent":98.611111111111, "quality":88.888888888889, "refuse_percent":13.888888888889, "land_time":149.3784, "click_through":"24", "click_through_percent":11.111111111111, "conversions":0, "conversions_submit":0, "conversions_submit_percent":0, "conversions_hold":0, "conversions_hold_percent":0, "conversions_decline":0, "conversions_decline_percent":0, "cr":0, "epc_real":0, "epc_estimate":0, "lead_avg":0, "lead_price":0, "expences":0, "income_real":0, "income_hold":0, "income_estimate":0, "roi_real":0, "roi_estimate":0}, {"group1":"site2.ru", "group2":"41", "group3":"", "clicks":409, "clicks_percent":24.69806763285, "unique":408, "unique_percent":99.755501222494, "quality":88.753056234719, "refuse_percent":10.268948655257, "land_time":223.2163, "click_through":"45", "click_through_percent":11.002444987775, "conversions":0, "conversions_submit":0, "conversions_submit_percent":0, "conversions_hold":0, "conversions_hold_percent":0, "conversions_decline":0, "conversions_decline_percent":0, "cr":0, "epc_real":0, "epc_estimate":0, "lead_avg":0, "lead_price":0, "expences":0, "income_real":0, "income_hold":0, "income_estimate":0, "roi_real":0, "roi_estimate":0}]}

Описание полей строки отчета

• group1 - значение первого поля группировки
• group2 - значение второго поля группировки
• group3 - значение третьего поля группировки
• clicks - количество кликов
• clicks_percent - процент кликов (от общего в отчете)
• unique - количество уников
• unique_percent - процент уников (от количества кликов)
• quality - оценка качества трафика от 0% до 100%
• refuse_percent - процент отказов
• land_time - среднее время на преленде
• click_through - количество переходов через преленд
• click_through_percent - процент переходов через преленд (от количества кликов)
• conversions - количество лидов
• conversions_submit - количество подтвержденных лидов
• conversions_submit_percent - процент подтвержденных лидов (от общего количества лидов)
• conversions_hold - количество лидов в ожидании
• conversions_hold_percent - процент лидов в ожидании(от общего количества лидов)
• conversions_decline - количество отклоненных лидов
• conversions_decline_percent - процент отклоненных лидов (от общего количества лидов)
• cr - CR (отношение количества лидов к локичеству кликов)
• epc_real - доход на клик, реальный
• epc_estimate - доход на клик, ожидаемый
• lead_avg - средний лид
• lead_price - цена лида
• expences - расход
• income_real - доход, реальный
• income_hold - доход, неподтвержденный
• income_estimate - доход, ожидаемый
• roi_real - ROI, реальный
• roi_estimate - ROI, ожидаемый

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

Доступно начиная с версии 04.16.

Пример запроса

http://tracker-domain.com/pages/streams_select_get.php?client_id=1234567890&api_key=4d8c70f89c5784b5b50db51de03ec789&api=json

Формат запроса

Пример ответа

[{"id":"1", "name":"Campaign1"}, {"id":"2", "name":"Campaign2"}]

Описание полей строки отчета

• id - id кампании
• name - название кампании

Получение списка источников

Доступно начиная с версии 04.16.

Пример запроса

http://tracker-domain.com/pages/sources_select_get.php?api_key=4d8c70f89c5784b5b50db51de03ec789&api=json

Формат запроса

Пример ответа

[{"id":"1", "name":"Source1"}, {"id":"2", "name":"Source2"}]

Описание полей строки отчета

• id - id источника
• name - название источника

Получение списка ID для фильтров

Доступно начиная с версии 04.16.

Пример запроса

http://tracker-domain.com/pages/filters_select_get.php?client_id=1234567890&api_key=4d8c70f89c5784b5b50db51de03ec789&api=json&sid=1&srid=1&filter=ad

Формат запроса

Пример ответа

[{"id":"1", "name":"123"}, {"id":"2", "name":"456"}]

Описание полей строки отчета

• id - id элемента
• name - значение элемента

Получение логов кликов, лидов, статусов, ошибок, постбек

Доступно начиная с версии 04.41.

Пример запроса

http://tracker-domain.com/pages/log_get.php?client_id=1234567890&api_key=4d8c70f89c5784b5b50db51de03ec789&api=json&type=clicks&date_from=2017.11.28&date_to=2017.11.28&page=1&rows=1000

Формат запроса

Пример ответа

Получение БЛ и ВЛ

Доступно начиная с версии 04.41.

Пример запроса

http://tracker-domain.com/pages/bw_get.php?client_id=1234567890&api_key=4d8c70f89c5784b5b50db51de03ec789&api=json&type=black&sid=1&srid=2&reason=all

Формат запроса

Пример ответа

{"items":["123","456","789"]}

Сохранение/Удаление БЛ и ВЛ

Доступно начиная с версии 04.41.

Пример запроса

http://tracker-domain.com/pages/bw_save.php?client_id=1234567890&api_key=4d8c70f89c5784b5b50db51de03ec789&api=json&type=black&sid=1&srid=2&reason=all&action=add&data=12,58,948

Формат запроса