API Reference
Полный перечень методов публичного API ActionPulse: две поверхности, схемы аутентификации, коды ответов и разделы по темам.
На этой странице
Раздел целиком сгенерирован из спецификации OpenAPI продукта: 214 метод(ов) в 29 раздел(ах) на 156 путях. Перечень не поддерживается руками: если спецификация меняется, а снимок нет, сборка документации падает.
- Версия API
- 1.0.0
- Методов
- 214
- Разделов
- 29
Две поверхности и базовые адреса
ActionPulse отдаёт два независимых HTTP-сервиса. Их нельзя путать: у них разные базовые адреса и разные типы ключей.
| Базовый адрес | Что это |
|---|---|
/api/v1 | query-api (control plane, :8080). All App API paths below are relative to this base. Exception: `GET /healthz` is served at the service root, not under /api/v1. |
{publicIngestUrl} | ingest-api (data plane, :8081). Only the `/v1/*` Ingest paths use this base together with `writeKey` auth. Configured via the PUBLIC_INGEST_URL environment variable. Переменная publicIngestUrl — базовый адрес приёма вашей установки; в облаке его выдаёт кабинет, в on-prem задаёт оператор. |
Схемы аутентификации
| Схема | Как передаётся | Что это |
|---|---|---|
bearerJWT | Authorization: Bearer … | Токен доступа пользователя кабинета. Выдаётся при входе. |
writeKey | Authorization: Bearer … | Ключ приёма проекта: браузерный токен или серверный секрет. |
releaseToken | Authorization: Bearer … | Отдельный токен для отметок релизов из CI/CD. |
writeKeyQuery | query: key | Тот же ключ приёма в query-параметре — только там, где заголовок недоступен. |
По умолчанию метод требует bearerJWT. Методы,
которым аутентификация не нужна, помечены на своих страницах как «Без аутентификации».
Приём событий
Разделы основного API
Auth 14 Registration, login, token refresh/logout, invite acceptance. Public (no JWT). Org 12 Organization settings and team membership. Me 8 Current user profile, password change, and active organization memberships. Projects 7 Project CRUD. ApiKeys 4 Project write-key management (issue, rotate, revoke). Queries 13 Ad-hoc funnel / retention / segmentation queries and the event catalog. SqlConsole 3 Read-only SQL console over ClickHouse (project-scoped, row-policy isolated). Reports 6 Saved reports (funnel / retention / segmentation / sql configs). Segments 5 Project-scoped saved, dynamic filter rules. Segments never materialize actor ids; `segment:{id}` references are resolved live for every query. Experiments 6 Project-scoped experiment definitions and bounded statistical readouts. ActionPulse analyzes customer-supplied exposure events; it never assigns traffic or acts as an A/B runner. Events 2 Raw event list (cursor pagination) and live SSE stream. Registry 15 Project event contracts, immutable schema versions, violations and bounded health signals. Behavior 9 Privacy-safe collection controls and bounded Forms/Behavior reports. LabeledEvents 10 Project-scoped no-code rules that derive named business events from privacy-safe autocapture signals. Replay 2 Bounded session listing and audited session-replay chunk reads. Diagnostics 4 JavaScript error and Web Vitals reports; impact/correlation values are estimates. Attribution 1 Bounded first/last-touch UTM source attribution reports. Actors 2 Project-scoped actor search and privacy-safe Person profiles. Exports 2 Bounded streaming CSV report exports and versioned NDJSON event export. Dashboards 10 Dashboards and their widgets, plus on-demand refresh. Alerts 22 Alert rules, seasonal preview/feedback, weekly digests, and release markers. Billing 13 Subscription, usage and checkout. Cloud-only — in MODE=onprem these routes are not mounted and return 404. The signed on-prem max_events_month is currently contract metadata; runtime event-quota enforcement is backlog. Imports 5 CSV / ClickHouse / Amplitude import jobs. Audit 2 Append-only project audit viewer and bounded CSV export (admin+). SecureSharing 5 Expiring read-only report/dashboard links and scheduled delivery. Privacy 3 Project-scoped subject erasure jobs. Available on every cloud plan and in on-prem mode; never controlled by a plan or license feature entitlement. License 2 On-prem license status and installation. Only mounted in MODE=onprem; absent (404) in cloud. Service 1 Health and operational endpoints.
Коды ответов
Ниже — все коды, которые встречаются в спецификации, и сколько методов их объявляют. Что означает каждый код ошибки и как на него реагировать — в статье Ошибки.
| Код | Объявлен у методов |
|---|---|
| 200 | 148 |
| 201 | 21 |
| 202 | 13 |
| 204 | 33 |
| 303 | 1 |
| 304 | 6 |
| 400 | 8 |
| 401 | 181 |
| 402 | 48 |
| 403 | 139 |
| 404 | 152 |
| 408 | 34 |
| 409 | 17 |
| 413 | 19 |
| 422 | 126 |
| 429 | 79 |
| 501 | 2 |
| 502 | 1 |
| 503 | 7 |
| 504 | 13 |
Источник — docs/api/openapi.yaml репозитория продукта,
OpenAPI 3.0.3, снимок 095579325c2d.