API: Behavior

Privacy-safe collection controls and bounded Forms/Behavior reports.

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

На этой странице

GET /projects/{id}/behavior/forms/purge
POST /projects/{id}/behavior/forms/purge
GET /projects/{id}/behavior/forms/purge/{jobID}
GET /projects/{id}/behavior/settings
PATCH /projects/{id}/behavior/settings
GET /projects/{id}/forms
GET /projects/{id}/forms/detail
GET /projects/{id}/pages/behavior
GET /projects/{id}/pages/behavior/urls

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

Методы раздела

GET /projects/{id}/behavior/forms/purge
POST /projects/{id}/behavior/forms/purge
GET /projects/{id}/behavior/forms/purge/{jobID}
GET /projects/{id}/behavior/settings
PATCH /projects/{id}/behavior/settings
GET /projects/{id}/forms
GET /projects/{id}/forms/detail
GET /projects/{id}/pages/behavior
GET /projects/{id}/pages/behavior/urls

GET /projects/{id}/behavior/forms/purge

List the latest project forms-data purge jobs (admin+)

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

Параметры

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

Ответы

Код	Что означает	Тело
200	At most 50 jobs, newest first.	`object`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`

POST /projects/{id}/behavior/forms/purge

Enqueue deletion of all collected form-interaction data (admin+)

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

Not plan-gated. At most one queued/running purge exists for a project.

Параметры

Имя	Где	Тип	Описание
`id` обязателен	Путь	`integer (int32)`	Project id.
`X-Confirm-Purge` обязателен	Заголовок	`enum(true)`

Ответы

Код	Что означает	Тело
202	New or already-active project purge job.	`FormPurgeJob`
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	Explicit confirmation is missing (code=confirmation_required).	`Error`

GET /projects/{id}/behavior/forms/purge/{jobID}

Read one project-scoped forms-data purge job (admin+)

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

Параметры

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

Ответы

Код	Что означает	Тело
200	Current asynchronous purge state.	`FormPurgeJob`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`

GET /projects/{id}/behavior/settings

Read project collection and replay privacy controls (viewer+)

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

Параметры

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

Ответы

Код	Что означает	Тело
200	Persisted settings; absent rows resolve to strict, disabled defaults. Effective tracker collection is additionally plan-gated.	`BehaviorSettings`
401	Missing or invalid credentials (code=unauthorized)	`Error`
404	Resource not found (code=not_found)	`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`

PATCH /projects/{id}/behavior/settings

Atomically update collection and replay privacy controls (admin+)

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

Form values and input replay are never enabled by these flags.

Параметры

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

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

Поле	Тип	Описание
`autocapture_clicks` необязательно	`boolean`
`autocapture_hover_intent` необязательно	`boolean`
`autocapture_sections` необязательно	`boolean`
`autocapture_scroll` необязательно	`boolean`
`autocapture_forms` необязательно	`boolean`
`privacy_mode` необязательно	`enum(standard, strict)`
`replay_enabled` необязательно	`boolean`
`replay_sample_rate` необязательно	`number (double)`
`diagnostics_enabled` необязательно	`boolean`

Ответы

Код	Что означает	Тело
200	Updated settings.	`BehaviorSettings`
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`
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}/forms

List privacy-safe form conversion summaries (viewer+)

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

Starts and submits are deduplicated by actor/session using the project timezone. If both dates are omitted the latest 30 local calendar days are used; otherwise both are required and the maximum range is 400 days.

Параметры

Имя	Где	Тип	Описание
`id` обязателен	Путь	`integer (int32)`	Project id.
`date_from` необязателен	Query	`string (date)`	Inclusive local calendar date. Supply together with date_to; when both are omitted the latest 30 dates are used. Effective range max 400 days.
`date_to` необязателен	Query	`string (date)`	Inclusive local calendar date. Supply together with date_from; when both are omitted the latest 30 dates are used. Effective range max 400 days.
`filters` необязателен	Query	`string`	JSON-encoded array of at most 20 Filter objects, for example `[{"field":"country","op":"eq","value":"RU"}]`. Saved-segment references are not accepted by behavioral reports. The decoded value is limited to 8192 bytes and is bound into the cursor scope.
`cursor` необязателен	Query	`string`	Opaque cursor bound to project and the complete effective query scope.
`limit` необязателен	Query	`integer`	По умолчанию `50`.

Ответы

Код	Что означает	Тело
200	Cursor-paginated form summaries.	`FormsPage`
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`
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}/forms/detail

Rank form fields, including the last field before abandonment (viewer+)

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

Параметры

Имя	Где	Тип	Описание
`id` обязателен	Путь	`integer (int32)`	Project id.
`form` обязателен	Query	`string`	Exact privacy-safe form selector.
`url` необязателен	Query	`string`	Optional exact page URL.
`date_from` необязателен	Query	`string (date)`	Inclusive local calendar date. Supply together with date_to; when both are omitted the latest 30 dates are used. Effective range max 400 days.
`date_to` необязателен	Query	`string (date)`	Inclusive local calendar date. Supply together with date_from; when both are omitted the latest 30 dates are used. Effective range max 400 days.
`filters` необязателен	Query	`string`	JSON-encoded array of at most 20 Filter objects, for example `[{"field":"country","op":"eq","value":"RU"}]`. Saved-segment references are not accepted by behavioral reports. The decoded value is limited to 8192 bytes and is bound into the cursor scope.
`cursor` необязателен	Query	`string`	Opaque cursor bound to project and the complete effective query scope.
`limit` необязателен	Query	`integer`	По умолчанию `50`.

Ответы

Код	Что означает	Тело
200	Cursor-paginated field metrics; no entered values are returned.	`FormDetailPage`
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`
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}/pages/behavior

Read click, rage/dead-click and scroll-depth metrics for one URL (viewer+)

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

Параметры

Имя	Где	Тип	Описание
`id` обязателен	Путь	`integer (int32)`	Project id.
`url` обязателен	Query	`string`
`date_from` необязателен	Query	`string (date)`	Inclusive local calendar date. Supply together with date_to; when both are omitted the latest 30 dates are used. Effective range max 400 days.
`date_to` необязателен	Query	`string (date)`	Inclusive local calendar date. Supply together with date_from; when both are omitted the latest 30 dates are used. Effective range max 400 days.
`filters` необязателен	Query	`string`	JSON-encoded array of at most 20 Filter objects, for example `[{"field":"country","op":"eq","value":"RU"}]`. Saved-segment references are not accepted by behavioral reports. The decoded value is limited to 8192 bytes and is bound into the cursor scope.
`cursor` необязателен	Query	`string`	Opaque cursor bound to project and the complete effective query scope.
`limit` необязателен	Query	`integer`	По умолчанию `50`.

Ответы

Код	Что означает	Тело
200	Behavior metrics for the exact URL.	`BehaviorPage`
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}/pages/behavior/urls

List URLs with behavioral events (viewer+)

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

Параметры

Имя	Где	Тип	Описание
`id` обязателен	Путь	`integer (int32)`	Project id.
`date_from` необязателен	Query	`string (date)`	Inclusive local calendar date. Supply together with date_to; when both are omitted the latest 30 dates are used. Effective range max 400 days.
`date_to` необязателен	Query	`string (date)`	Inclusive local calendar date. Supply together with date_from; when both are omitted the latest 30 dates are used. Effective range max 400 days.
`filters` необязателен	Query	`string`	JSON-encoded array of at most 20 Filter objects, for example `[{"field":"country","op":"eq","value":"RU"}]`. Saved-segment references are not accepted by behavioral reports. The decoded value is limited to 8192 bytes and is bound into the cursor scope.
`cursor` необязателен	Query	`string`	Opaque cursor bound to project and the complete effective query scope.
`limit` необязателен	Query	`integer`	По умолчанию `50`.

Ответы

Код	Что означает	Тело
200	Cursor-paginated URLs ordered by event count.	`BehaviorURLsPage`
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`

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

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