Раздел содержит описание методов API, используемых при взаимодействии с отчетами системы.
При подготовке отчётов происходит обработка большого объёма данных, во избежание перегрузки сервера используется очередь отчётов для последовательного выполнения запросов на отчёты.
ReportRequest - в данном разделе представлены все возможные запросы в очередь на построение отчётов. В ответе запроса на отчёт возвращается new_uuid
- id созданного отчёта в очереди, в дальнейшем этот id будет использоваться для получения подготовленного отчёта.
Важно: В очередь нельзя добавить более 3-х отчётов одновременно. Для получения списка отчётов в очереди используется запрос ReportRequest/Get.
После подготовки, отчёт будет храниться на сервере в соответствии с настройкой REPORT_PREPARED_REPORT_LIFETIME (по умолчанию 5 дней). Готовый отчёт можно сохранить с помощью запроса ReportPrepared/Save, в данном случае отчёт будет хранится до удаления с помощью запроса ReportPrepared/Remove
Подготовленный отчёт можно получить с помощью запроса ReportPrepared/Get, в параметр запроса request_uuid
передаётся значение new_uuid
, полученное в ответе запроса на постановку отчёта в очередь (для получения отчёта с данными необходимо передать параметр "include_data": true
). Каждый отчёт содержит разные данные в зависимости от запрашиваемого отчёта.