03-12-2018 23:59

Отчет по лидам

POST   /bs-core/reports/lead-report-list/{dateFrom}/{dateTo}

Отчет формирует данные по всем лидам созданным за указанный период. Для уменьшения времени формирования отчета в этом методе следует применять фильтры. Для того чтобы получить отчет по всем лидам в теле запроса метода передается пустая коллекция [].

Запрос

POST /bs-core/reports/lead-report-list/2016-01-01/2018-11-28?output-mode=file-sync
[
	{
		"entity":"com.pq.establ.dict.LeadEmul",
		"field":"id",
		"value1":3450
	}
]
Описание параметров
Параметр Обязателен Тип данных Описание
dateFrom R [date]

Начальная дата отчета в формате YYYY-MM-DD.
dateTo R [date]

Конечная дата отчета в формате YYYY-MM-DD
count О [bool]

Cформировать количество записей в отчете. Этот параметр служит для быстрого получения информации о количестве записей информации. Если передать этот параметр, то будет возвращено количество записей в отчете в структуре джейсона, не формирую самого отчета. 

Например:

{
    "status": "ok",
    "timestamp": 1543479512046,
    "data": 157
}

В отчете будет произведено 157 записей.
output-mode О [string]

Если передать этот параметр, то отчет будет сформирован в файловом хранилище и в ответ будет возвращена джейсон структура с количеством записей в отчете. Более подробное описание флага output-mode смотрите здесь.

 
entity О [string]

Сущность по которой надо фильтровать. Возможные значения берутся из метода "Получение сущностей для фильтрации в отчете по Лидам". 

Например, если метод "Получение сущностей для фильтрации в отчете по Лидам" возвращает

{
   "status": "ok",
   "timestamp": 1497125020649,
   "data": [   {
      "object": "com.pq.establ.dict.LeadEmul",
      "label": "lead",
      "type": "DICTIONARY",
      "singleValue": true
   }]
}

то в этом параметре передается значение "com.pq.establ.dict.LeadEmul" или другие значения поля "object". Например "entity":"com.pq.establ.dict.LeadEmul".
field О [string]

Поле по которому происходит фильтрация. Значение поля можно узнать из поля "оbject", возвращаемое методом "Получение полей сущности для фильтрации в отчете по Лидам". Например метод возвращает 

{
"status": "ok",
"timestamp": 1497125384418,
"data":    [
{
"object": "creationDate",
"label": "Дата создания",
"type": "STRING",
"singleValue": true
},
{
"object": "firstName",
"label": "Имя",
"type": "STRING",
"singleValue": true
},
{
"object": "howYouKnow",
"label": "Как вы о нас узнали",
"type": "DICTIONARY",
"singleValue": true
},
{
"object": "id",
"label": "Номер лида",
"type": "INTEGER",
"singleValue": false
}       
   ]
}
 
тогда можем использовать значения creationDate, firstName, howYouKnow и id. Например "field":"id", "field":"creationDate".
value1 О [object]

Тип данных этого поля определяется в методе "Получение полей сущности для фильтрации в отчете по Лидам". Если типом данных например является "Dictionary", то передается идентификатор элемента этого справочника.

Если нужно получить лиды с creationDate от 2016-06-10, то тогда значение этого поля передаем, как "value1":">2016-06-10" , анологично "<". Пример передаваемого в теле запроса фильтра: { "entity":"com.pq.establ.dict.LeadEmul", "field":"creationDate", "value1":">2016-06-10" }. Кроме того нужно учитывать даты в самом отчете, передаваемые в адресной строке, которые уже определяют условие для поля creationDate.
value2 О [object]

Это поле нужно передавать в том случае, если значение передаваемого поля field предполагает ввод второго значения. Это видно из поля "singleValue" метода "Получение полей сущности для фильтрации в отчете по Лидам", т.е. если значение поля "singleValue" false, то этот параметр нужно передавать. Этот второй параметр нужно передавать, если например сущности для отчета выбираются за определённый период времени.

Ответ


                        {
    "status": "ok",
    "timestamp": 1543479512046,
    "data": 1
}
Описание параметров
Параметр Обязателен Тип данных Описание
data О [int]

data - Количество записей в отчете, в случае если вызов происходит с параметром count=true или при передаче параметра output-mode. Иначе приходит excel-файл.