09.06.2026 17:31

AddRequest

[POST] …/v1/report/addrequest

Единый метод добавления запроса на отчет.

Перед постановкой отчета в очередь выполняется проверка лимита дискового пространства аккаунта.
Если лимит исчерпан, метод возвращает ошибку 1222 (disk_space).

Для отчетов 28, 29, 30, 31 объект request_data сохраняется в очередь без изменения состава полей.
API проверяет report_id, права доступа, что request_data является объектом, и общие поля периода start_date/end_date.
Параметры конкретного отчета проверяются при формировании отчета.

Входные параметры

Название Тип данных Обязательность Описание параметра
report_id Int64 Обязательный Id отчета из метода Report/Get
request_data Object Обязательный Параметры конкретного отчета. Размер JSON-объекта не должен превышать 4096 символов

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

{
  "report_id": 21,
  "request_data": {
    "start_date": 1735689600,
    "end_date": 1738291199,
    "firm_id": 1,
    "currency_id": 1,
    "report_type": 1
  }
}

Пример запроса для отчета по сделкам

{
  "report_id": 30,
  "request_data": {
    "start_date": 1778266801,
    "end_date": 1781031599,
    "pipeline_ids": [4, 3],
    "deal_type_ids": [1, 2],
    "include_without_responsible": false
  }
}

Выходные параметры

Название Тип данных Описание параметра
new_uuid string UUID созданного запроса в очереди

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

{
  "ok": true,
  "result": {
    "new_uuid": "c266086a-2553-461b-a75b-3f57860aa283"
  }
}