Список методов

Метод API URL Описание Комментарий
GET /reports Получение списка отчетов
GET /reports/pipelines/days/{report-id} Получение отчета по воронкам на каждый день по выбранному периоду Страница “Показатели по дням”
POST /reports/pipelines/days Сохранение измененного пользователем отчета Страница “Показатели по дням”
POST /report/pipelines Сохранение обновленного порядка/наименования воронок (блоков) в отчете Страница “Настройки”
GET /report/periods Получение списка периодов для отчёта по итоговым показателям Страница “Итоговые показатели”, будет нужно позже
GET /report/pipelines/period Получение отчета по воронкам по выбранным периодам Страница “Итоговые показатели”, будет нужно позже
GET /reports/sync Синхронизация отчетов с данными из AMO CRM
GET /reports/sync/{report-id} Синхронизация конкретного отчета с данными из AMO CRM

Ссылка на формат API: https://newyorrker.gitbook.io/api/ Ссылка на схему БД: https://app.diagrams.net/#G1AN9PAOvP0bX9HdDJ2taYk7RndGMVeGMJ

Описание API

Отображаем пользователю доступные только для него данные. Понять, какие данные доступны можно организации. Таблица Organization и колонки organization_id в других таблицах.

GET: /reports

Получение списка отчетов

Модель:

interface Report {
  id: string;
  name: string;
}

Откуда взять данные

Model Table
Report.id report.report_id
Report.name report.name

Пример результата

[
  {
    "id": "1",
    "name": "Черная пятница"
  },
  {
    "id": "2",
    "name": "Инстаграм"
  },
  {
    "id": "3",
    "name": "Телеграм"
  }
]

GET: /report/pipelines/days

Получение отчета по воронкам на каждый день по выбранному периоду

NEW: в тело ответа добавлена модель functions, представляющая список функций, доступных для применения к строкам отчета

Если интервал дат (from, to) не передан, вытащить по воронке все данные из БД(за весь период, который есть)

Параметры