| Метод API | URL | Описание | Комментарий | Статус |
|---|---|---|---|---|
| GET | /reports | Получение списка всех отчетов | Главная страница | API реализован, залито на стенд |
| POST | /reports | Создание нового отчета | Главная страница | API реализован, залито на стенд, логика создания в разработке |
| PUT | /reports/{reportId} | Изменение названия отчета (со страницы со всеми отчетами) | Главная страница | API реализован, залито на стенд, логика создания в разработке |
| DELETE | /reports/{reportId} | Удаление отчета | Главная страница? | API реализован, залито на стенд, логика создания в разработке |
| GET | /reports/{reportId}/final | Получение конкретного отчета (итоговые показатели) | Страница “Итоговые показатели” | Будет реализован в рамках версии 0.3.0 |
| PUT | /reports/{reportId}/final | Внесение изменений в отчет (итоговые показатели) | Страница “Итоговые показатели” | Будет реализован в рамках версии 0.3.0 |
| GET | /reports/{reportId}/days | Получение конкретного отчета (показатели по дням) | Страница “Показатели по дням” | API реализован, залито на стенд |
| PUT | /reports/{reportId}/days | Внесение изменений в отчет (показатели по дням) | Страница “Показатели по дням” | API реализован, залито на стенд, логика создания в разработке |
| GET | /reports/sync | Синхронизация отчетов с данными из AMO CRM | Главная страница | API реализован, залито на стенд |
| GET | /reports/sync/{report-id} | Синхронизация конкретного отчета с данными из AMO CRM | Главная страница | API реализован, залито на стенд |
| Предыдущий метод и эндпоинт | Описание | Текущий метод и эндпоинт | Описание |
|---|---|---|---|
| GET /reports | Получение списка отчетов | GET /reports | Получение списка всех отчетов |
| GET /reports/pipelines/days/{report-id} | Получение отчета по воронкам на каждый день по выбранному периоду | GET /reports/{reportId}/days | Получить конкретный отчет (показатели по дням) |
| POST /reports/pipelines/days | Сохранение измененного пользователем отчета | PUT /reports/{reportId}/days | Внести изменения в отчет (показатели по дням) |
| POST /report/pipelines | Сохранение обновленного порядка/наименования воронок (блоков) в отчете | PUT /reports/{reportId}/days | Внести изменения в отчет (показатели по дням) |
| GET /report/periods | Получение списка периодов для отчёта по итоговым показателям | GET /reports/{reportId}/final | Получить конкретный отчет (показатели по дням) |
| GET /report/pipelines/period | Получение отчета по воронкам по выбранным периодам | - | - |
| GET /reports/sync | Синхронизация отчетов с данными из AMO CRM | GET /reports/sync | Синхронизация всех отчетов |
| GET /reports/sync/{report-id} | Синхронизация конкретного отчета с данными из AMO CRM | GET /reports/sync/{reportId} | Синхронизация конкретного отчета |
| - | - | POST /reports | Создать новый отчет |
| - | - | PUT /reports/{reportId} | Изменить название отчета (со страницы со всеми отчетами) |
| - | - | DELETE /reports/{reportId} | Удалить отчет |
Получение списка всех отчетов, доступных пользователю
В рамках данного метода не предусмотрено использование модели запроса в Request Body
| Parameter Type | Name | isRequired | DataType | Comment |
|---|---|---|---|---|
| Header | authToken | + | String | Пользовательский токен аутентификации |
| Query | reportId | + | String | Идентификатор отчета |
type Response = {reports: ReportListItemDto[];};
interface ReportListItemDto {
id: string;
name: string;
}