Эндпоинты
Полный контракт: приём данных (вы пушите) и получение результатов (Филин отдаёт, вы забираете сами - pull).
Бета. Контракт может меняться. Доступ к боевому API открывается после подключения (оплаты).
Приём данных (вы пушите)
| Метод | Назначение |
|---|---|
POST /v1/employees |
сотрудники (bulk-массив) |
POST /v1/pipelines |
воронки со стадиями |
POST /v1/deals |
сделки и лиды (bulk) |
POST /v1/contacts, POST /v1/companies |
контакты и компании (опц.) |
POST /v1/communications |
звонки, переписки, письма, встречи (bulk) - ядро |
POST /v1/notes, POST /v1/attachments |
заметки и вложения (опц.) |
POST /v1/validate |
проверка payload без записи: обязательные поля, форматы, связность. Возвращает список ошибок построчно |
Получение результатов (pull - вы забираете сами)
| Метод | Назначение |
|---|---|
GET /v1/scoring/leads |
баллы сделок 0-100 + рекомендации, за период |
GET /v1/scoring/employees |
баллы сотрудников + разбор ошибок и сильных сторон |
GET /v1/focus |
«Фокус» - приоритетные действия дня |
GET /v1/actions |
рекомендованные действия в CRM. Отдаются, только если вы включили запись в CRM (см. Запись в CRM) |
Как часто опрашивать: результаты обновляются после ночного цикла - достаточно забирать
GET /scoring/*и/focusраз в сутки утром. Новые данные внутри дня можно слать в любой момент, они попадут в ближайший ночной прогон.
Параметры выдачи
Для всех GET-эндпоинтов результатов:
since=YYYY-MM-DD- только результаты, обновлённые с даты (для инкрементального забора: забирайте изменённое, а не всё каждый раз).limit- размер страницы (по умолчанию 200, максимум 1000).cursor- курсор постраничного забора. В ответе -next_cursor(пусто = конец).
У энтерпрайза 20+ сотрудников выдача большая - идите по страницам до пустого next_cursor.