API: Actors
Project-scoped actor search and privacy-safe Person profiles.
Раздел собран из спецификации OpenAPI продукта: 2 метод(ов). Поверхность — query-api (основной API, база /api/v1). Все методы требуют аутентификации.
Методы раздела
/projects/{id}/actors Prefix-search actors in a bounded project date range
Cloud requires the Growth or Scale person_profile entitlement; on-prem requires person_profile in the current verified signed-license feature subset. Case-sensitive prefix search of at least three Unicode characters over actor_id and user_id. In the persisted identity model a non-empty user_id is also the canonical actor_id; no unbounded substring scan is performed. Results are ordered by actor_id and cursor-paginated. If both dates are omitted, the last 30 calendar days in the project's timezone are used; the maximum range is 400 calendar days. Supplying only one date is a validation error. Every ClickHouse query remains scoped by project, both effective time bounds and a finite limit.
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
id обязателен | Путь | integer (int32) | Project id. |
query обязателен | Query | string | Actor_id/user_id prefix of at least three Unicode characters (never a substring). |
date_from необязателен | Query | string (date) | Inclusive local calendar date (YYYY-MM-DD). |
date_to необязателен | Query | string (date) | Inclusive local calendar date (YYYY-MM-DD). |
cursor необязателен | Query | string | Opaque cursor scoped to project, prefix, timezone and the effective UTC bounds. |
limit необязателен | Query | integer | По умолчанию 50. |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 200 | Actor search page | ActorSearchPage |
| 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 |
/projects/{id}/actors/{actor_id} Get a privacy-safe Person profile and actor timeline
Cloud requires the Growth or Scale person_profile entitlement; on-prem requires person_profile in the current verified signed-license feature subset. Reads the exact persisted actor_id used by funnel membership; linked aliases are display metadata and are never merged into the timeline at read time. Summary fields are calculated over the effective bounded date range and are independent of the optional event filter. The timeline is newest-first with a stable (event_time,event_id) cursor and is read through the existing by_actor projection. Every project member, including viewer, receives only response-time sanitized traits and properties; PII-bearing property names are omitted, and raw props, URL and referrer are never returned. If both dates are omitted, the last 30 calendar days in the project's timezone are used; the maximum range is 400 calendar days. Supplying only one date is a validation error. A foreign project or actor is not disclosed and returns 404.
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
id обязателен | Путь | integer (int32) | Project id. |
actor_id обязателен | Путь | string | Exact persisted actor_id encoded as one URL path segment. To prevent browser dot-segment normalization, canonical clients encode `.`/`..` and identities beginning with `~a~` as `~a~` followed by the unpadded base64url encoding of the identity's UTF-8 bytes; other identities may use ordinary percent-encoding. |
event необязателен | Query | string | Exact event_name filter for timeline rows only. |
date_from необязателен | Query | string (date) | Inclusive local calendar date (YYYY-MM-DD). |
date_to необязателен | Query | string (date) | Inclusive local calendar date (YYYY-MM-DD). |
cursor необязателен | Query | string | Opaque cursor scoped to project, actor, timezone, effective UTC bounds and event filter. |
limit необязателен | Query | integer | По умолчанию 50. |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 200 | Actor profile and one timeline page | ActorProfile |
| 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 |
Источник раздела — docs/api/openapi.yaml репозитория продукта,
версия API 1.0.0, OpenAPI 3.0.3,
снимок 095579325c2d.
Расхождение снимка со спецификацией роняет сборку документации.