# MaxBotStat

> Документация MaxBotStat: аналитика, прокси-вебхуки, рассылки и REST API для Telegram- и Max-ботов.

Прокси-вебхуки, контакты, диалоги, воронки и рассылки для Telegram- и Max-ботов. Без переписывания вашего кода.

## Table of Contents

### Начало работы

- [Что такое MaxBotStat и быстрый старт](https://docs.maxbotstat.ru/guide/getting-started.md): Кратко — что делает MaxBotStat, какие задачи решает, как начать работу за 2 минуты и что подключать в первую очередь.
- [Регистрация и вход](https://docs.maxbotstat.ru/guide/account.md): Как зарегистрировать аккаунт в MaxBotStat, подтвердить email шестизначным кодом, войти и сменить пароль.
- [Добавление бота — Telegram и Max](https://docs.maxbotstat.ru/guide/add-bot.md): Как создать бота в @BotFather для Telegram или получить access token Max и подключить его к MaxBotStat.

### Прокси-вебхуки

- [Как работает прокси-вебхук](https://docs.maxbotstat.ru/guide/proxy-webhook.md): Архитектура прокси MaxBotStat — путь сообщения от Telegram/Max до вашего backend, формат payload, безопасность proxy_secret.
- [Telegram — подключение через прокси](https://docs.maxbotstat.ru/guide/proxy-telegram.md): Пошаговая установка webhook Telegram-бота на MaxBotStat — setWebhook, allowed_updates, проверка getWebhookInfo.
- [Max — подключение через прокси](https://docs.maxbotstat.ru/guide/proxy-max.md): Установка webhook Max-бота на MaxBotStat через platform-api.max.ru, особенности access_token и payload.
- [Прокси api.telegram.org для обхода блокировок](https://docs.maxbotstat.ru/guide/proxy-api-base.md): Использование api-tg.capybara.maxbotstat.ru как замены api.telegram.org для регионов с ограниченным доступом — настройка и пример кода.

### Аналитика

- [Контакты и диалоги](https://docs.maxbotstat.ru/guide/contacts.md): Раздел контактов в MaxBotStat — фильтры, метаданные пользователя, аватары, история диалогов и поиск.
- [Сообщения и активность](https://docs.maxbotstat.ru/guide/messages.md): Раздел «Сообщения» в кабинете MaxBotStat — фильтры по дате и пользователю, графики активности, экспорт.
- [UTM-источники и атрибуция](https://docs.maxbotstat.ru/guide/sources.md): Как разметить трафик в Telegram-боте через /start-параметр, настроить utm_key и сопоставить значения с кампаниями.
- [Воронки в Telegram-боте](https://docs.maxbotstat.ru/guide/funnel.md): Как настроить воронку этапов в MaxBotStat — фильтры по тексту/intent'у, расчёт конверсии и визуализация.
- [Намерения (intents) для категоризации сообщений](https://docs.maxbotstat.ru/guide/intents.md): Как описать intent в MaxBotStat — ключевые слова и регулярки, использовать для воронок и сегментации рассылок.

### Коммуникации

- [Массовые рассылки в Telegram и Max](https://docs.maxbotstat.ru/guide/broadcast.md): Как отправить рассылку в MaxBotStat — текст, фото, аудио, файл; ограничения Telegram, отчёт о доставке и REST API.
- [Отправка одиночных сообщений из кабинета](https://docs.maxbotstat.ru/guide/send.md): Как отправить сообщение конкретному пользователю Telegram или Max через кабинет MaxBotStat и REST API v1.
- [Поддержка пользователей](https://docs.maxbotstat.ru/guide/support.md): Тикет-система MaxBotStat — как создать обращение, прикрепить файлы, общаться с командой и получать уведомления на email.

### Тарифы

- [Тарифы и оплата](https://docs.maxbotstat.ru/guide/billing.md): Как устроены тарифы MaxBotStat, как оплатить через Robokassa и где смотреть текущий план.

### REST API v1

- [Обзор REST API v1](https://docs.maxbotstat.ru/api/overview.md): Базовый URL, авторизация, формат ответов и пагинация публичного REST API MaxBotStat.
- [Аутентификация в REST API](https://docs.maxbotstat.ru/api/authentication.md): Выпуск API-ключей в кабинете MaxBotStat, scope read/write, отзыв ключа, передача в заголовке X-API-Key или Authorization Bearer.
- [REST API — боты](https://docs.maxbotstat.ru/api/bots.md): Эндпоинты GET /bots и GET /bots/{id} в MaxBotStat — формат полей, примеры запросов и ответов.
- [REST API — контакты](https://docs.maxbotstat.ru/api/contacts.md): Эндпоинты для списка контактов и карточки контакта в MaxBotStat — пагинация, метаданные, атрибуция.
- [REST API — сообщения и диалоги](https://docs.maxbotstat.ru/api/messages.md): Эндпоинты для истории сообщений и диалогов в MaxBotStat — фильтры по дате, пользователю, формат полей.
- [REST API — статистика бота](https://docs.maxbotstat.ru/api/stats.md): Эндпоинты сводной статистики и таймлайна по дням в MaxBotStat — поля ответа, примеры использования для дэшбордов.
- [REST API — источники и intents](https://docs.maxbotstat.ru/api/sources-intents.md): Эндпоинты для UTM-источников и категорий сообщений (intents) в MaxBotStat — формат ответа и примеры запросов.
- [REST API — отправка сообщений](https://docs.maxbotstat.ru/api/send.md): Эндпоинт POST /bots/{id}/send для отправки одиночного сообщения через MaxBotStat — параметры, ошибки, примеры.
- [REST API — массовые рассылки](https://docs.maxbotstat.ru/api/broadcast.md): Эндпоинт POST /bots/{id}/broadcast для запуска рассылки в Telegram/Max через MaxBotStat — поведение, лимиты, формат ответа.
- [Webhook-подписки от MaxBotStat](https://docs.maxbotstat.ru/api/webhooks.md): Получайте события message.created, message.outbound, contact.created на свой URL — формат payload, подпись HMAC-SHA256, тестовая доставка.
- [Коды ошибок REST API](https://docs.maxbotstat.ru/api/errors.md): Список HTTP-кодов и сообщений об ошибках MaxBotStat — что значит каждый, как обработать в клиенте.

### Other

- [FAQ — частые вопросы по MaxBotStat](https://docs.maxbotstat.ru/faq.md): Ответы на типичные вопросы про MaxBotStat — Telegram прокси, аналитика бота, рассылки, REST API, лимиты, безопасность.