analytics-v2
Эндпоинтов: 23
GET /api/projects/{id}/analytics/acquisition
Справочники рекламной аналитики проекта
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_e726cbfec2fecb7c
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Массивы sources, placements, links и expenses |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
POST /api/projects/{id}/analytics/acquisition/budgets
Сохранить рекламный бюджет простой start-ссылки
Авторизация: Cookie (connect.sid) или Bearer PAT
Атомарно создаёт источник, техническое размещение, публичную метку и дневной расход; существующая метка используется повторно без изменения прежних даты начала и пояса. Сумма — decimal-строка. Поддерживает фиксированный курс, дату курса, примечание и явное равномерное распределение untilDay с allocation=equal. link_, ref и ref_ запрещены. Конфликт маршрута или занятой ссылки даёт 409. Повторный POST добавляет отдельную финансовую запись, не является идемпотентным.
Operation ID: post_api_projects_id_analytics_acquisition_budgets_f794bf7383a2afe3
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 201 | Сохранённый дневной расход |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/exchange-rate
Бесплатный официальный курс USD/RUB ЦБ на дату рекламного бюджета
Авторизация: Cookie (connect.sid) или Bearer PAT
Ключ не нужен. rubPerUsd — decimal-строка RUB за 1 USD. effectiveDay может быть раньше requestedDay в выходной. Ничего не сохраняет: передайте курс и дату в расход явно. Ошибка сервиса 503, ручной ввод остаётся доступен.
Operation ID: get_api_projects_id_analytics_acquisition_exchange_rate_de4fc3d58ee33a63
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
day | query | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Официальный курс и дата действия |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/expenses
Получить дневные расходы
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_expenses_7d37eb1c65d7dd85
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Включает архивные записи с archivedAt |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
POST /api/projects/{id}/analytics/acquisition/expenses
Создать: дневные расходы
Авторизация: Cookie (connect.sid) или Bearer PAT
Все связи проверяются в проекте. Расходы: allocation=equal и untilDay явно распределяют сумму по дням с сохранением итога; estimated=true. Курс exchangeRateRubPerUsd — RUB за один USD. Ссылка имеет постоянную bc_-метку и не создаёт login-код. Реферер должен быть подтверждённым пользователем проекта.
Operation ID: post_api_projects_id_analytics_acquisition_expenses_54b668160ad08fdd
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 201 | Созданный объект; для расходов массив дневных строк |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
PATCH /api/projects/{id}/analytics/acquisition/expenses/{resourceId}
Исправить или архивировать: дневные расходы
Авторизация: Cookie (connect.sid) или Bearer PAT
Изменения сохраняются в аудите. archived=true архивирует, false восстанавливает. Нельзя изменить code, источник/бота опубликованной ссылки или связь размещения.
Operation ID: patch_api_projects_id_analytics_acquisition_expenses_resourceId_a01ebd48cb3ec18e
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
resourceId | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Обновлённый объект |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/expenses/{resourceId}/history
История изменений: дневные расходы
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_expenses_resourceId_history_4c33d969dc544cb6
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
resourceId | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Автор, время, состояние до и после изменения |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/links
Получить публичные ссылки
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_links_53b12220458a2a10
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Включает архивные записи с archivedAt |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
POST /api/projects/{id}/analytics/acquisition/links
Создать: публичные ссылки
Авторизация: Cookie (connect.sid) или Bearer PAT
Все связи проверяются в проекте. Расходы: allocation=equal и untilDay явно распределяют сумму по дням с сохранением итога; estimated=true. Курс exchangeRateRubPerUsd — RUB за один USD. Ссылка имеет постоянную bc_-метку и не создаёт login-код. Реферер должен быть подтверждённым пользователем проекта.
Operation ID: post_api_projects_id_analytics_acquisition_links_8c8487bfe0153255
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 201 | Созданный объект; для расходов массив дневных строк |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
PATCH /api/projects/{id}/analytics/acquisition/links/{resourceId}
Исправить или архивировать: публичные ссылки
Авторизация: Cookie (connect.sid) или Bearer PAT
Изменения сохраняются в аудите. archived=true архивирует, false восстанавливает. Нельзя изменить code, источник/бота опубликованной ссылки или связь размещения.
Operation ID: patch_api_projects_id_analytics_acquisition_links_resourceId_491c83c812a23805
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
resourceId | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Обновлённый объект |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/links/{resourceId}/history
История изменений: публичные ссылки
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_links_resourceId_history_d87e352f16829a47
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
resourceId | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Автор, время, состояние до и после изменения |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/placements
Получить размещения
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_placements_0d723b489ffb3937
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Включает архивные записи с archivedAt |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
POST /api/projects/{id}/analytics/acquisition/placements
Создать: размещения
Авторизация: Cookie (connect.sid) или Bearer PAT
Все связи проверяются в проекте. Расходы: allocation=equal и untilDay явно распределяют сумму по дням с сохранением итога; estimated=true. Курс exchangeRateRubPerUsd — RUB за один USD. Ссылка имеет постоянную bc_-метку и не создаёт login-код. Реферер должен быть подтверждённым пользователем проекта.
Operation ID: post_api_projects_id_analytics_acquisition_placements_bf9c3bc03d70d515
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 201 | Созданный объект; для расходов массив дневных строк |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
PATCH /api/projects/{id}/analytics/acquisition/placements/{resourceId}
Исправить или архивировать: размещения
Авторизация: Cookie (connect.sid) или Bearer PAT
Изменения сохраняются в аудите. archived=true архивирует, false восстанавливает. Нельзя изменить code, источник/бота опубликованной ссылки или связь размещения.
Operation ID: patch_api_projects_id_analytics_acquisition_placements_resourceId_6f7bd75441c841e0
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
resourceId | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Обновлённый объект |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/placements/{resourceId}/history
История изменений: размещения
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_placements_resourceId_history_250f3396f33a0951
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
resourceId | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Автор, время, состояние до и после изменения |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/report
Результаты рекламных источников, бюджет и цена нового пользователя
Авторизация: Cookie (connect.sid) или Bearer PAT
Без from/to — весь срок. День рекламного бюджета определяется сохранённым поясом технического размещения. returningUsers — люди с первым контактом до начала окна, снова вошедшие по метке; обычное сообщение не равно рекламному возвращению. Повторный вход впервые пришедшего внутри окна не добавляет вернувшегося. Для обрезанного дня цена null. RUB/USD раздельно, пересчёт только по сохранённому ручному RUB-за-USD курсу. Деньги — decimal-строки. costPerUser=null при неполной истории, неизвестном расходе/курсе или отсутствии новых. 3000.00 RUB / 200 = 15.00 RUB. Запуски Telegram не являются кликами.
Operation ID: get_api_projects_id_analytics_acquisition_report_58d3137e0658e325
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
includeSources | query | нет | — | — |
tokenId | query | нет | — | — |
from | query | нет | — | — |
to | query | нет | — | — |
timezone | query | нет | — | — |
currency | query | нет | — | — |
placementId | query | нет | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Рекламный снимок |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/sources
Получить источники
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_sources_a3708ddd325928e4
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Включает архивные записи с archivedAt |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
POST /api/projects/{id}/analytics/acquisition/sources
Создать: источники
Авторизация: Cookie (connect.sid) или Bearer PAT
Все связи проверяются в проекте. Расходы: allocation=equal и untilDay явно распределяют сумму по дням с сохранением итога; estimated=true. Курс exchangeRateRubPerUsd — RUB за один USD. Ссылка имеет постоянную bc_-метку и не создаёт login-код. Реферер должен быть подтверждённым пользователем проекта.
Operation ID: post_api_projects_id_analytics_acquisition_sources_d62cfc85f746ee71
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 201 | Созданный объект; для расходов массив дневных строк |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
PATCH /api/projects/{id}/analytics/acquisition/sources/{resourceId}
Исправить или архивировать: источники
Авторизация: Cookie (connect.sid) или Bearer PAT
Изменения сохраняются в аудите. archived=true архивирует, false восстанавливает. Нельзя изменить code, источник/бота опубликованной ссылки или связь размещения.
Operation ID: patch_api_projects_id_analytics_acquisition_sources_resourceId_72427641eb1e7ceb
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
resourceId | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Обновлённый объект |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/acquisition/sources/{resourceId}/history
История изменений: источники
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_acquisition_sources_resourceId_history_c5e416a4fa8d513c
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
resourceId | path | да | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Автор, время, состояние до и после изменения |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |
GET /api/projects/{id}/analytics/activity-leaders
Топ десять пользователей и групп по активности
Авторизация: Cookie (connect.sid) или Bearer PAT
Operation ID: get_api_projects_id_analytics_activity_leaders_8eb9eb314deedfb4
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
tokenId | query | нет | — | — |
granularity | query | нет | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Рейтинги |
| 400 | Некорректный диапазон, метрика или бот |
| 401 | Нет авторизации |
| 403 | Нет доступа к проекту или боту |
| 500 | Ошибка чтения |
| 503 | База недоступна |
GET /api/projects/{id}/analytics/range
Точные диапазоны и сравнение метрик
Авторизация: Cookie (connect.sid) или Bearer PAT
До 365 дней и 500 точек. period исключает from/to; comparison=explicit требует compare_from/compare_to.
Operation ID: get_api_projects_id_analytics_range_2dfa53c4e3717df5
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
metric | query | да | — | — |
tokenId | query | нет | — | — |
period | query | нет | — | — |
from | query | нет | — | — |
to | query | нет | — | — |
step | query | нет | — | — |
comparison | query | нет | — | — |
compare_from | query | нет | — | — |
compare_to | query | нет | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Диапазоны и изменение итогов |
| 400 | Некорректный диапазон, метрика или бот |
| 401 | Нет авторизации |
| 403 | Нет доступа к проекту или боту |
| 500 | Ошибка чтения |
| 503 | База недоступна |
GET /api/projects/{id}/analytics/v2/snapshot
Единый снимок подтверждённой аналитики v2
Авторизация: Cookie (connect.sid) или Bearer PAT
Новые и активные пользователи требуют направленного действия; обычная группа — отдельное наблюдение. period либо from+to, [from,to), до 500 точек. total_users — всё время. coverage объясняет ограничения старых сборок и первого взаимодействия. previous=null для all. Все карточки имеют один as_of/revision. На analytics-changed, reconnect и next_recompute_at получите новый снимок; уведомление не содержит значений.
Operation ID: get_api_projects_id_analytics_v2_snapshot_ffb3b5b897d01974
Параметры
| Имя | In | Обязательный | Описание | Пример |
|---|---|---|---|---|
id | path | да | — | — |
tokenId | query | нет | — | — |
period | query | нет | — | — |
from | query | нет | — | — |
to | query | нет | — | — |
step | query | нет | — | — |
timezone | query | нет | — | "Europe/Moscow" |
comparison | query | нет | — | — |
Ответы
| Код | Описание |
|---|---|
| 200 | Согласованный снимок и полнота истории |
| 400 | Некорректные поля, даты, сумма или шаг |
| 401 | Требуется сессия или Bearer PAT |
| 403 | Нет доступа к проекту или бот не принадлежит проекту |
| 404 | Объект не найден внутри проекта |
| 409 | Конфликт публичной метки либо ключа повторной доставки |
| 500 | Не удалось получить снимок |
| 503 | Снимок или сохранение временно недоступны |