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

API: Registry

Project event contracts, immutable schema versions, violations and bounded health signals.

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

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

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

List tenant and ActionPulse-managed event contracts (viewer+)

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

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
status необязателен Query enum(draft, active, deprecated)
source необязателен Query enum(browser, server, import, system, unknown)
cursor необязателен Query string Opaque Registry cursor bound to project and the complete effective query scope.
limit необязателен Query integer По умолчанию 50.

Ответы

Код Что означает Тело
200 Event contracts enriched with bounded observed volume/first/last-seen aggregates. object
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
422 Request failed validation (code=validation_failed) Error
POST /projects/{id}/registry/events

Register an event and immutable schema version 1 (analyst+)

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

The pp.* namespace is reserved for ActionPulse-managed system events and cannot be registered by a customer.

Параметры

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

Тело запроса application/json , обязательно

Поле Тип Описание
event_name обязательно string Customer event name; the pp.* namespace is reserved.
display_name необязательно string
description необязательно string
owner_team необязательно string
source необязательно enum(browser, server, import, system, unknown) По умолчанию "unknown".
status необязательно enum(draft, active, deprecated) По умолчанию "draft".
properties необязательно array<RegistryProperty>

Ответы

Код Что означает Тело
201 Event contract and schema version 1 created. RegistryEvent
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
404 Resource not found (code=not_found) Error
409 Event or schema version already exists. Error
422 Request failed validation (code=validation_failed) Error
GET /projects/{id}/registry/events/{event_name}

Read one event contract and its current schema (viewer+)

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

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
event_name обязателен Путь string Exact event contract name, including ActionPulse-managed pp.* definitions.

Ответы

Код Что означает Тело
200 Event contract enriched with bounded observation aggregates. RegistryEvent
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
PATCH /projects/{id}/registry/events/{event_name}

Update mutable event metadata (analyst+)

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

Managed pp.* contracts cannot be changed.

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
event_name обязателен Путь string Exact event contract name, including ActionPulse-managed pp.* definitions.

Тело запроса application/json , обязательно

Поле Тип Описание
display_name необязательно string
description необязательно string
owner_team необязательно string
source необязательно enum(browser, server, import, system, unknown)
status необязательно enum(draft, active, deprecated)

Ответы

Код Что означает Тело
200 Updated event contract. RegistryEvent
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
404 Resource not found (code=not_found) Error
422 Request failed validation (code=validation_failed) Error
GET /projects/{id}/registry/events/{event_name}/history

List event contract audit history (viewer+)

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

The additive advanced capability is not activated as a shipped pricing revision on this branch.

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
event_name обязателен Путь string Exact event contract name, including ActionPulse-managed pp.* definitions.
cursor необязателен Query string Opaque Registry cursor bound to project and the complete effective query scope.
limit необязателен Query integer По умолчанию 50.

Ответы

Код Что означает Тело
200 Cursor-paginated history snapshots. object
401 Missing or invalid credentials (code=unauthorized) Error
402 Product access is not active. `code=trial_expired` means the organization's trial ended without payment; `code=subscription_required` means there is no current paid subscription or live trial. In both cases ingest, mutations and plan-gated read/write capabilities are paused until a plan is paid; details.billing_url, when present, points to the cabinet billing page. Error
403 Authenticated but not permitted (code=forbidden) Error
404 Resource not found (code=not_found) Error
422 Request failed validation (code=validation_failed) Error
GET /projects/{id}/registry/events/{event_name}/versions

List immutable schema versions (viewer+)

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

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
event_name обязателен Путь string Exact event contract name, including ActionPulse-managed pp.* definitions.
cursor необязателен Query string Opaque Registry cursor bound to project and the complete effective query scope.
limit необязателен Query integer По умолчанию 50.

Ответы

Код Что означает Тело
200 Cursor-paginated versions. object
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
422 Request failed validation (code=validation_failed) Error
POST /projects/{id}/registry/events/{event_name}/versions

Append an immutable schema version (analyst+)

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

Managed pp.* contracts cannot be changed.

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
event_name обязателен Путь string Exact event contract name, including ActionPulse-managed pp.* definitions.

Тело запроса application/json , обязательно

Поле Тип Описание
properties обязательно array<RegistryProperty>

Ответы

Код Что означает Тело
201 New schema version. RegistrySchemaVersion
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
404 Resource not found (code=not_found) Error
409 Schema version already exists. Error
422 Request failed validation (code=validation_failed) Error
GET /projects/{id}/registry/events/{event_name}/versions/{version}

Read one immutable schema version (viewer+)

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

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
event_name обязателен Путь string Exact event contract name, including ActionPulse-managed pp.* definitions.
version обязателен Путь integer

Ответы

Код Что означает Тело
200 Exact schema version. RegistrySchemaVersion
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
GET /projects/{id}/registry/health

Calculate deterministic registry health signals (viewer+)

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

Compares the requested window with the immediately preceding equal baseline window. The additive advanced capability is not activated as a shipped pricing revision on this branch.

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
from обязателен Query string (date-time) RFC3339 inclusive window start; from/to must form a non-empty range of at most 31 days.
to обязателен Query string (date-time) RFC3339 exclusive window end; from/to must form a non-empty range of at most 31 days.
cursor необязателен Query string Opaque Registry cursor bound to project and the complete effective query scope.
limit необязателен Query integer По умолчанию 50.

Ответы

Код Что означает Тело
200 Cursor-paginated deterministic health signals. object
401 Missing or invalid credentials (code=unauthorized) Error
402 Product access is not active. `code=trial_expired` means the organization's trial ended without payment; `code=subscription_required` means there is no current paid subscription or live trial. In both cases ingest, mutations and plan-gated read/write capabilities are paused until a plan is paid; details.billing_url, when present, points to the cabinet billing page. Error
403 Authenticated but not permitted (code=forbidden) 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
503 Registry ClickHouse read model unavailable. Error
GET /projects/{id}/registry/settings

Read the project registry validation mode (viewer+)

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

Параметры

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

Ответы

Код Что означает Тело
200 Project registry mode; projects default to monitor. RegistrySettings
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
PATCH /projects/{id}/registry/settings

Change the project registry validation mode (admin+)

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

Параметры

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

Тело запроса application/json , обязательно

Поле Тип Описание
mode обязательно enum(off, monitor, enforce)

Ответы

Код Что означает Тело
200 Updated registry mode. RegistrySettings
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
404 Resource not found (code=not_found) Error
422 Request failed validation (code=validation_failed) Error
GET /projects/{id}/registry/violations

List sanitized contract violations in a bounded window (viewer+)

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

Raw property values, identities and URLs are never stored in this violation read model.

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
from обязателен Query string (date-time) RFC3339 inclusive window start; from/to must form a non-empty range of at most 31 days.
to обязателен Query string (date-time) RFC3339 exclusive window end; from/to must form a non-empty range of at most 31 days.
event необязателен Query string
code необязателен Query string
disposition необязателен Query enum(accepted, rejected)
cursor необязателен Query string Opaque Registry cursor bound to project and the complete effective query scope.
limit необязателен Query integer По умолчанию 50.

Ответы

Код Что означает Тело
200 Cursor-paginated sanitized violation records. 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
503 Registry ClickHouse read model unavailable. Error
GET /projects/{id}/semantics/meaningful-activity

Read the customer-confirmed meaningful activity definition (viewer+)

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

This project-scoped business definition is separate from the Event Registry schema contract. It is ready only while the selected event is active and has a non-empty customer-facing display name.

Параметры

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

Ответы

Код Что означает Тело
200 Current computed definition, including the normal unconfigured state. MeaningfulActivityDefinition
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
PUT /projects/{id}/semantics/meaningful-activity

Confirm which event represents meaningful user activity (analyst+)

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

The event must belong to this project, be active and have a non-empty display name. The definition revision and append-only history advance in the same PostgreSQL transaction.

Параметры

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

Тело запроса application/json , обязательно

Поле Тип Описание
event_name обязательно string

Ответы

Код Что означает Тело
200 Confirmed ready definition. MeaningfulActivityDefinition
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
404 Resource not found (code=not_found) Error
422 Request failed validation (code=validation_failed) Error
DELETE /projects/{id}/semantics/meaningful-activity

Clear the meaningful activity definition (analyst+)

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

Preserves and advances the project definition revision and audit history.

Параметры

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

Ответы

Код Что означает Тело
200 Unconfigured definition after clearing the event binding. MeaningfulActivityDefinition
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
404 Resource not found (code=not_found) Error

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

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