report - Republer/rpb-api GitHub Wiki

Отчеты

Все отчеты работают по единому принципу.

Параметры

Параметр Описание
start Номер строки, с которой необходимо начинать выдачу. Отсчет ведется с 0. По умолчанию 0
limit Количество строк в выдаче. Максимальное значение 5000. По умолчанию 5000
sort Сортировка выдачи. Передается в виде строки состоящей из двух значений поля и направления сортировки, разделенной вертикальной палочкой. Допустимо передавать несколько сортировок.
groups Массив группировок
filter Массив фильтров. Подробнее ниже.
Пример сортировки

campaign_id|desc

Фильтры

Фильтры представляют собой массив строк, состоящих из 3 значений, разделенных символом |.

В формате: COLUMN_NAME|VALUE|TYPE, пример: site_id|1234|lt

Каждый новый фильтр добавляется в запрос новым параметром filter=

Поле type может принимать значения:

Значение Описание
eq Точное совпадение
lt Значение в БД должно быть меньше указанного
gt Значение в БД должно быть больше указанного
lte Значение в БД должно быть меньше или равно указанного
gte Значение в БД должно быть больше или равно указанного
is_null Если value = 1, тогда отбираются значения не равные NULL
like Ищет вхождение фразы в поле. При необходимости можно использовать символ %
unlike Антоним like. Находит все строки, значние якоторые не содеражат указанную фразу
in Поиск числовых значений из списка, перечисленных черезх запятую. Например: 12,15,78
not_in Антоним in. Находит все строки не содержащие значения из списка
inset Аналогичен in только для тексовых значений. Например: jan,feb
bw Интервал дат. Задается через разделитель ;. Например: 2016-01-01;2016-12-31

Результат

Параметр Тип Описание
rows Array Массив строк основной выдачи
summary Object Суммарные значения Может отсутствовать в отчете.
rows_count Int Общее количество строк. Рекомендуется использовать для вычисления количества страниц.