К содержанию
ActionPulse

API: Events

Raw event list (cursor pagination) and live SSE stream.

Кому
Разработчики, интегрирующие ActionPulse по HTTP
Проверено

Раздел собран из спецификации OpenAPI продукта: 2 метод(ов). Поверхность — query-api (основной API, база /api/v1). Все методы требуют аутентификации.

Методы раздела
GET /projects/{id}/events

List raw events or historical Integration Doctor records

Аутентификация
Bearer: токен доступа (JWT)
operationId
getProjectsIdEvents

`view=doctor` requires `from` and `to`, uses a half-open range of at most 31 days, and returns metadata v2 for accepted events plus sanitized enforce-rejected attempts. Doctor cursors are bound to the project and every filter. The existing SSE endpoint remains the only live stream.

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
view необязателен Query enum(doctor)
event необязателен Query array<string> Repeat the parameter to match any of the selected event names in the regular list; view=doctor accepts at most one event value.
user_id необязателен Query string
anonymous_id необязателен Query string
anon_id необязателен Query string Compatibility alias for anonymous_id.
actor_id необязателен Query string
invalid_only необязателен Query boolean По умолчанию false.
sdk_name необязателен Query string
source необязателен Query enum(browser, server, import, system, unknown)
release необязателен Query string
from необязателен Query string (date-time) RFC3339
to необязателен Query string (date-time) RFC3339
cursor необязателен Query string Opaque scope-bound pagination cursor
limit необязателен Query integer

Ответы

Код Что означает Тело
200 Events page object
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
408 Query exceeded the endpoint-specific timeout (code=query_timeout) Error
422 Request failed validation (code=validation_failed) Error
429 Rate limit (code=rate_limited) or plan quota exceeded (code=quota_exceeded). On ingest operations a live trial that exhausted its total event cap answers code=trial_quota_exceeded instead of quota_exceeded. Заголовки: Retry-After. Error
GET /projects/{id}/events/stream

Live event stream (Server-Sent Events)

Аутентификация
Bearer: токен доступа (JWT)
operationId
getProjectsIdEventsStream

Returns a text/event-stream of live events for the project (sampled above 20 msg/s).

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.

Ответы

Код Что означает Тело
200 SSE stream string
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error

Источник раздела — docs/api/openapi.yaml репозитория продукта, версия API 1.0.0, OpenAPI 3.0.3, снимок 095579325c2d. Расхождение снимка со спецификацией роняет сборку документации.

← Все разделы API Reference