Everglow Agent API

Read-only API для AI-агентов. Аналитика, клиенты, сделки студии красоты Everglow.

Быстрый старт

Base URL: http://agent.ever-glow.ru

Авторизация: заголовок X-API-Key

Формат дат: YYYY-MM-DD

Валюта: RUB (российские рубли)

OpenAPI spec: http://agent.ever-glow.ru/openapi.json

curl -H "X-API-Key: ega_YOUR_KEY" http://agent.ever-glow.ru/analytics/summary?start_date=2025-01-01&end_date=2025-01-31

Формат ответа

Все read-only эндпоинты возвращают единый AI-friendly формат:

{
  "data": { ... },
  "metadata": {
    "description": "Описание данных",
    "filters_applied": { "start_date": "2025-01-01", ... },
    "currency": "RUB"
  },
  "field_hints": {
    "leads": "Количество новых лидов за период",
    "revenue": "Выручка в рублях"
  }
}

field_hints — подсказки о значении каждого поля. Используй их для интерпретации данных.

Эндпоинты

1. KPI Summary

GET/analytics/summary

Ключевые метрики: лиды, записи, визиты, выручка, конверсии, LTV, ROI.

ПараметрТипОбязательныйОписание
start_datedateнетНачало периода
end_datedateнетКонец периода
sourcestringнетИсточник лида (Instagram, VK, Site...)
studiostringнетНазвание студии
statusstringнетСтатус сделки
pipeline_idintнетID воронки (по умолчанию 2146744)
manager_idintнетID менеджера

Возвращает: leads, records, visits, revenue, realized_revenue, cost, roi, avg_check, cpl, conversion_record, conversion_visit, sales_cycle, ltv и др.

2. Trend (временной ряд)

GET/analytics/trend

Количество лидов по дням/неделям/месяцам.

ПараметрТипОбязательныйОписание
start_datedateнетНачало периода
end_datedateнетКонец периода
group_bystringнетday (по умолч.), week, month
sourcestringнетФильтр по источнику
studiostringнетФильтр по студии
pipeline_idintнетID воронки
manager_idintнетID менеджера

Возвращает: массив [{"label": "2025-01-15", "value": 42}]

3. Funnel (воронка)

GET/analytics/funnel

Количество сделок на каждом этапе воронки.

ПараметрТипОбязательныйОписание
start_datedateнетНачало периода
end_datedateнетКонец периода
source / studio / pipeline_id / manager_idнетСтандартные фильтры

Возвращает: {"total": 5000, "stages": [{"id": "142", "label": "Успешно реализовано", "value": 3200}]}

4. Sources (источники лидов)

GET/analytics/sources

Источники лидов с количеством и конверсией в запись.

ПараметрТипОбязательныйОписание
start_date / end_datedateнетПериод
studio / pipeline_id / manager_idнетФильтры

Возвращает: массив [{"source": "Instagram", "count": 52, "booked": 44, "conversion_rate": 84.6}]

5. ROI (окупаемость маркетинга)

GET/analytics/roi

ROI по каждому источнику: лиды, расход, выручка, ROI%, CPL.

ПараметрТипОбязательныйОписание
start_date / end_datedateнетПериод
studio / pipeline_id / manager_idнетФильтры

Возвращает: [{"source": "VK", "leads": 43, "revenue": 154835, "spend": 50000, "roi": 209.7, "cpl": 1163}]

6. Customer Search

GET/customers

Поиск клиентов по телефону (автонормализация) или имени.

ПараметрТипОбязательныйОписание
searchstringнетТелефон, имя или фамилия
skipintнетOffset (default: 0)
limitintнетЛимит 1-100 (default: 20)

Возвращает: {"items": [...], "total": 150, "page": 1, "size": 20}

7. Customer Profile

GET/customers/{phone}

Полный профиль клиента: данные, активные пакеты, последние 10 визитов.

ПараметрТипОбязательныйОписание
phonepathдаТелефон в любом формате (79161234567, +79161234567, 89161234567)

Возвращает: phone, first_name, last_name, segment, loyalty_tier, lifetime_value, total_visits, total_revenue, active_packages[], recent_visits[]

8. Deals List

GET/deals

Список CRM-сделок с фильтрами. Удалённые сделки автоматически исключены.

ПараметрТипОбязательныйОписание
start_datedateнетНачало периода
end_datedateнетКонец периода
sourcestringнетИсточник
studiostringнетСтудия
statusstringнетСтатус/этап
pipeline_idintнетID воронки
manager_idintнетID менеджера
searchstringнетПоиск по имени, телефону, ID сделки
skipintнетOffset (default: 0)
limitintнетЛимит 1-100 (default: 20)

Возвращает: {"items": [...], "total": 2329, "page": 1, "size": 20}

Поля сделки: id, name, customer_name, customer_phone, stage, stage_name, source_type, budget (RUB), pipeline_name, created_at_external

Коды ошибок

КодОписание
401Невалидный или отсутствующий API-ключ
404Ресурс не найден (клиент по телефону)
422Неверные параметры запроса
429Превышен rate limit (60 req/min)

Примечания для AI-агентов