Документация InstantBase
Всё, что нужно для интеграции и работы с InstantBase. Выберите раздел или воспользуйтесь поиском.
🚀 Быстрый старт
Всего 3 шага, чтобы начать получать данные:
bash
# 1. Получите API-ключ в личном кабинете
# 2. Отправьте первое событие
curl -X POST https://api.instantbase.online/v1/track \
-H "X-API-Key: ваш_ключ" \
-H "Content-Type: application/json" \
-d '{
"event": "page_view",
"user_id": "user_123",
"properties": {
"page": "/home",
"referrer": "google"
}
}'
# 3. Через 5 минут данные появятся в дашборде
💡 Совет: Используйте тестовый ключ для отладки. Он не влияет на лимиты и статистику.
📋 Примеры под ваш бизнес
Интернет-магазин
Отслеживайте товары, корзину, промокоды и заказы. Анализируйте воронку продаж.
SaaS-сервис
Следите за подписками, активациями, удержанием и LTV клиентов.
Игры
Анализируйте уровни, ресурсы, внутриигровые покупки и прогресс игроков.
Мобильное приложение
Отслеживайте экраны, действия, версии приложения и вовлеченность.
🔑 Основные концепции
События
Всё в InstantBase строится вокруг событий. Событие — это любое действие пользователя: просмотр страницы, покупка, клик, регистрация.
json
{
"event": "purchase",
"user_id": "12345",
"properties": {
"revenue": 1499.99,
"product_id": "prod_789",
"quantity": 2
}
}
Метаданные
Метаданные позволяют описать бизнес-логику: отметить событие как заказ, задать шаг воронки, указать цвет для графика.
json
{
"event": "page_view",
"user_id": "123",
"_metadata": {
"funnel_sales_step": 1,
"funnel_sales_name": "Главная",
"is_activation": true
}
}
📌 Обратите внимание: Метаданные не обязательны, но они делают аналитику по-настоящему мощной.
Стандартные метаданные
| Акроним | Описание | Пример |
|---|---|---|
is_order |
Помечает событие как заказ для аналитики выручки | true |
is_activation |
Помечает событие как активацию пользователя | true |
funnel_sales_step |
Номер шага в воронке продаж | 1, 2, 3 |
funnel_sales_name |
Название шага в воронке | "Главная" |
event_display_name |
Отображаемое имя события в интерфейсе | "Просмотр главной" |
event_color |
Цвет события на графиках | "#FF5733" |
📚 Следующие шаги
🔧 Интеграция
- → JavaScript SDK
- → Python SDK
- → PHP SDK
- → Мобильные SDK