REST API и OpenAPI 3.1
Полный справочник из 128 эндпоинтов: запись событий, агрегации, когорты, экспорт. Скачайте спецификацию и сгенерируйте клиент в один клик.
База знаний · Docs · v3.2
База знаний и документы
Технические справочники, стартовые пакеты и видеоуроки для разработчиков. Всё, чтобы подключить Shrtnk Analytics к вашей системе и довести данные до живого дашборда — без поиска по чужим форумам.
★★★★★
Обновлено 14 марта 2024 · 240+ статей и примеров кода
Статей240▲ 18 за месяц
Примеров кода612▲ 42
Языков6+ Go, Rust
Просмотры документациипоследние 30 дней
REST API · справочник128
SDK и клиентские библиотеки86
Webhooks и события54
612 примеров
Руководство по API
Один REST-интерфейс для всех данных
Единый набор эндпоинтов для записи событий, запроса срезов и управления дашбордами. Документация в формате OpenAPI, примеры на шести языках и песочница с мгновенным ответом.
SDK и клиентские библиотеки
Официальные пакеты для Python, Go, Node.js, Java, PHP и Rust. Типизация, ретраи и батчинг событий — уже встроены в клиент.
Аутентификация и ключи
API-ключи с гранулярными правами, ротация без простоя и OAuth 2.0 для сервисных аккаунтов. Примеры конфигурации в каждом гайде.
Webhooks и события
Подписки на аномалии, пороги KPI и обновления прогноза. Подпись HMAC, повторные доставки и журнал всех событий в консоли.
Лимиты и квоты
10 000 запросов в минуту на базовом тарифе, до 120 000 на Энтерпрайзе. Прозрачные заголовки X-RateLimit-Remaining в каждом ответе.
Версии и миграции
Версия 3.2 актуальна с 14 марта 2024. Старые мажорные версии поддерживаются ещё 12 месяцев — таблица несовместимых изменений прилагаем.
Стартовые пакеты
Готовые шаблоны для быстрого старта
Залейте пакет в ваш репозиторий и получите рабочую связку: конфиг, примеры событий и первый дашборд. Всё лицензировано MIT — меняйте под себя.
Starter · Python (FastAPI)
Пакет shrtnk-fastapi-starter (48 КБ): мидлвар для сбора событий, батчинг и 3 готовых среза. Установка через pip install.
Starter · Node.js (NestJS)
Пакет @shrtnk/nestjs (62 КБ): модуль, интерсепторы и декоратор @Track для автоматической телеметрии контроллеров.
Starter · Go (Gin)
Пакет github.com/shrtnk/go-sdk (39 КБ): middleware, контекст запроса и потокобезопасный батч-сентер с настройкой таймаутов.
Шаблоны дашбордов
12 готовых дашбордов: e-commerce, SaaS-подписки, логистика и финтех. JSON-конфигурации, которые импортируются в конструктор за секунды.
Терминальные CLI-утилиты
Утилита shrtnk-cli для проверки ключей, отправки тестовых событий и экспорта срезов в CSV прямо из консоли разработчика.
Postman-коллекция
Коллекция из 96 запросов с переменными окружения и pre-request-скриптами для получения токена. Импорт в Postman и Insomnia в один клик.
Видеоуроки
Курс для разработчика за 40 минут
Пять коротких роликов, которые проведут от первого API-ключа до работающего дашборда. Субтитры на русском и английском, код из каждого урока доступен для скачивания.
Урок 1 · Первичная настройка
07:12 — Создаём проект, генерируем API-ключ и отправляем первое событие. Разбираем структуру ответа и коды ошибок.
Урок 2 · Батчинг событий
09:34 — Как собирать события пакетами по 500 записей, настраивать таймауты и обрабатывать частичные успехи без потери данных.
Урок 3 · Построение срезов
11:48 — Запросы агрегаций, когорты и сравнение периодов. Показываем, как получить LTV и рояль-ти за один вызов API.
Урок 4 · Webhooks на практике
08:26 — Подписываемся на аномалии, проверяем подпись HMAC и отправляем алерт в Slack. Разбираем повторные доставки.
Урок 5 · Производительность
10:05 — Оптимизируем нагрузку: сжатие, пул соединений и кэширование срезов. Держим 99,99% SLA на пиковых нагрузках.
Курс целиком + код
46:25 — Конспект, слайды и GitHub-репозиторий с проектами из всех уроков. Обновляется вместе с каждой мажорной версией API.
Словарь терминов
Глоссарий Shrtnk Analytics
Ключевые понятия, которые встречаются в документации и дашбордах. Разбираем на конкретных цифрах, чтобы не путать метрики между собой.
Рояль-ти (royal-ty)
Выручка с одного платящего клиента за период. В примере: ₽4,2M при 3 800 активных подписчиков. Пересчитывается в реальном времени.
LTV (пожизненная ценность)
Суммарная прибыль от клиента за весь цикл. Прогноз на 30 дней: ₽86K. Используется для расчёта допустимых затрат на привлечение.
Конверсия воронки
Доля пользователей, дошедших до целевого этапа. В дашборде: 6,8% от показа до оплаты. Платформа подсвечивает шаг с наибольшим оттоком.
Аномалия
Отклонение метрики от ожидаемого диапазона более чем на 3 сигмы. Триггерит webhook и алерт. Порог настраивается от 1,5 до 5 сигм.
Когорта
Группа пользователей, объединённых общим событием — например, регистрацией в марте 2024. Позволяет сравнивать удержание между волнами запуска.
SLA (уровень сервиса)
Гарантированная доступность платформы: 99,99% на тарифах «Бизнес» и «Энтерпрайз». Отслеживается по часам простоя за месяц.
Остались вопросы по документации?
Подключите данные за 15 минут и получите первый инсайт в первый час. А команда разработчиков Shrtnk поможет настроить пайплайн под вашу архитектуру.
Вопросы по документации
Частые вопросы разработчиков
Не нашли нужного в справочнике? Инженеры поддержки отвечают в течение 15 минут в рабочее время.
После регистрации в консоли console.shrtnk.app автоматически создаётся тестовый проект с ключом, лимитом 100 000 событий в месяц и доступом к песочнице. Ключи можно генерировать и отзывать в разделе «Безопасность».
Python, Go, Node.js, Java, PHP и Rust. Все пакеты публикуются в официальных реестрах, типизированы и проходят CI-тесты с каждой мажорной версией API. Для остальных языков доступен чистый REST.
Да. В любой момент доступен полный экспорт в CSV, Parquet или через API-эндпоинт /v3/events/export. Данные остаются вашими — никакого vendor lock-in.
Справочник синхронизирован с релизами API. К каждой мажорной версии прилагается таблица изменений и гайд по миграции. Текущая версия 3.2 вышла 14 марта 2024.
Нет. Все уроки, конспекты и GitHub-репозитории с кодом доступны без ограничений и без отдельной подписки. Материал обновляется вместе с документацией.