External Statistics API
Добро пожаловать в документацию по External Statistics API Teleport.
Этот раздел описывает получение статистических данных через API для использования во внешних системах — биллинге, аналитике, BI-платформах и внутренних сервисах.
Назначение
External Statistics API позволяет получать данные о потреблении трафика через:
- Teleport P2P
- CDN
- NODR
Данные могут использоваться для:
- расчёта биллинга
- построения отчётности
- аналитики потребления
- интеграции во внешние системы
Доступные интервалы агрегации
Поддерживаются следующие интервалы:
- 1 минута
- 15 минут
- 60 минут
- день
Обязательные параметры запроса
| Параметр | Описание |
|---|---|
| Teleport-Token | API токен с разрешением external-stat |
| startTimestamp | Начало периода (Unix timestamp) |
| endTimestamp | Конец периода (Unix timestamp) |
Обязательные параметры
Если startTimestamp или endTimestamp отсутствуют, запрос выполнен не будет.
Ограничения по времени
- startTimestamp не может быть больше endTimestamp
- startTimestamp не может быть больше текущего времени сервера
- endTimestamp не может быть больше текущего времени сервера
Правила округления
Временные границы автоматически корректируются в соответствии с выбранным интервалом агрегации:
- startTimestamp округляется вниз до ближайшей границы интервала
- endTimestamp округляется вверх до ближайшей границы интервала
Логика агрегации
Результат зависит от переданных фильтров:
| Переданные параметры | Результат |
|---|---|
| apiKeys + streamIds | Статистика с разбивкой по apiKey и streamId |
| только apiKeys | Статистика с разбивкой по apiKey |
| только streamIds | Статистика с разбивкой по streamId |
| только startTimestamp + endTimestamp | Общая статистика за период |
Время выполнения и объем данных
Время выполнения и объем данных
Обратите внимание, если у вас большой объем данных, то время выполнения увечится!
Ограничения по максимальному диапазону запроса
Срок хранения данных и максимальный диапазон зависят от выбранного интервала агрегации и наличия фильтрации по стримам:
| Интервал | Без учета стримов | С учетом стримов |
|---|---|---|
| daily | 360 дней | 60 дней |
| 1 минута | 1 день | 1 час |
| 15 минут | 28–30 дней | 2 дня |
| 60 минут | 90 дней | 7 дней |