API: Alerts

Alert rules, seasonal preview/feedback, weekly digests, and release markers.

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

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

PATCH /alerts/{aid}
DELETE /alerts/{aid}
GET /alerts/{aid}/events
PUT /alerts/{aid}/events/{eid}/feedback
DELETE /alerts/{aid}/events/{eid}/feedback
POST /alerts/{aid}/test
GET /projects/{id}/alerts
POST /projects/{id}/alerts
POST /projects/{id}/alerts/seasonal/preview
GET /projects/{id}/release-markers
POST /projects/{id}/release-markers
GET /projects/{id}/release-markers/{mid}
PATCH /projects/{id}/release-markers/{mid}
DELETE /projects/{id}/release-markers/{mid}
POST /projects/{id}/release-markers/deploy
GET /projects/{id}/release-tokens
POST /projects/{id}/release-tokens
POST /projects/{id}/release-tokens/{tid}/revoke
GET /projects/{id}/weekly-digest
PUT /projects/{id}/weekly-digest
POST /projects/{id}/weekly-digest/preview
GET /projects/{id}/weekly-digest/runs

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

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

PATCH /alerts/{aid}
DELETE /alerts/{aid}
GET /alerts/{aid}/events
PUT /alerts/{aid}/events/{eid}/feedback
DELETE /alerts/{aid}/events/{eid}/feedback
POST /alerts/{aid}/test
GET /projects/{id}/alerts
POST /projects/{id}/alerts
POST /projects/{id}/alerts/seasonal/preview
GET /projects/{id}/release-markers
POST /projects/{id}/release-markers
GET /projects/{id}/release-markers/{mid}
PATCH /projects/{id}/release-markers/{mid}
DELETE /projects/{id}/release-markers/{mid}
POST /projects/{id}/release-markers/deploy
GET /projects/{id}/release-tokens
POST /projects/{id}/release-tokens
POST /projects/{id}/release-tokens/{tid}/revoke
GET /projects/{id}/weekly-digest
PUT /projects/{id}/weekly-digest
POST /projects/{id}/weekly-digest/preview
GET /projects/{id}/weekly-digest/runs

PATCH /alerts/{aid}

Update an alert rule (analyst+)

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

Requires alerts in the cloud EffectivePlan or current verified on-prem signed-license feature subset. Keeping or adding a webhook additionally requires alerts_webhook; removing an existing webhook remains allowed. Alert type is immutable, so `config` is validated against the stored rule type rather than a client-supplied discriminator.

Параметры

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

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

Поле	Тип	Описание
`name` необязательно	`string`
`config` необязательно	`anyOf<MetricThresholdAlertConfig \| NoEventsAlertConfig \| FunnelDropAlertConfig \| SeasonalAlertConfig \| DataQualityAlertConfig>`	Configuration variant selected by the enclosing alert rule type.
`channels` необязательно	`array<oneOf<AlertEmailChannel \| AlertTelegramChannel \| AlertWebhookChannel>>`	Replaces the channel list. Omitted/empty webhook secret keeps the secret for the matching configured webhook URL; removing the channel removes its encrypted secret. A single existing webhook may also retain its secret while its URL is edited only when both old and new lists contain one webhook; an ambiguous URL change with multiple webhooks requires a replacement secret.
`enabled` необязательно	`boolean`
`interval_sec` необязательно	`integer`	Evaluation interval. Changing it makes the rule due for a fresh evaluation.
`cooldown_sec` необязательно	`integer`

Ответы

Код	Что означает	Тело
200	Updated rule	`AlertRule`
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`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`Error`
422	Request failed validation (code=validation_failed)	`Error`

DELETE /alerts/{aid}

Delete an alert rule (analyst+)

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

Параметры

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

Ответы

Код	Что означает	Тело
204	Deleted	пусто
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 /alerts/{aid}/events

List fired events for a rule in a bounded UTC range

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

Параметры

Имя	Где	Тип	Описание
`aid` обязателен	Путь	`integer (int64)`	Alert rule id.
`date_from` необязателен	Query	`string (date-time)`	Inclusive lower bound. If both bounds are omitted, the server uses the last 90 days.
`date_to` необязателен	Query	`string (date-time)`	Exclusive upper bound. If both bounds are omitted, the server uses the last 90 days.
`limit` необязателен	Query	`integer`	По умолчанию `100`.
`cursor` необязателен	Query	`string`

Ответы

Код	Что означает	Тело
200	Fired events	`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`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

PUT /alerts/{aid}/events/{eid}/feedback

Mark a seasonal firing as a false positive (analyst+)

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

Feedback is an annotation and never retrains or mutates historical baseline math.

Параметры

Имя	Где	Тип	Описание
`aid` обязателен	Путь	`integer (int64)`	Alert rule id.
`eid` обязателен	Путь	`integer (int64)`	Alert event row id.

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

Поле	Тип	Описание
`verdict` обязательно	`enum(false_positive)`
`note` необязательно	`string`

Ответы

Код	Что означает	Тело
200	Stored feedback	`AlertEventFeedback`
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`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`Error`
422	Request failed validation (code=validation_failed)	`Error`

DELETE /alerts/{aid}/events/{eid}/feedback

Remove false-positive feedback (analyst+)

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

Параметры

Имя	Где	Тип	Описание
`aid` обязателен	Путь	`integer (int64)`	Alert rule id.
`eid` обязателен	Путь	`integer (int64)`	Alert event row id.

Ответы

Код	Что означает	Тело
204	Feedback removed	пусто
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 /alerts/{aid}/test

Evaluate a rule and send a real test notification (analyst+)

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

Requires alerts in the cloud EffectivePlan or current verified on-prem signed-license feature subset. Rules containing a webhook additionally require alerts_webhook. Ignores cooldown and delivers through the same notifier, signature and retry contract as a real alert. The attempt is recorded in delivery history with is_test=true and does not affect the real-alert cooldown.

Параметры

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

Ответы

Код	Что означает	Тело
200	Evaluation and per-channel delivery outcome	`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}/alerts

List alert rules in a project

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

Параметры

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

Ответы

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

POST /projects/{id}/alerts

Create an alert rule (analyst+)

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

Requires alerts in the cloud EffectivePlan or current verified on-prem signed-license feature subset. A webhook channel additionally requires alerts_webhook in the same policy.

Параметры

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

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

Схема тела: oneOf<AlertMetricThresholdCreateInput | AlertNoEventsCreateInput | AlertFunnelDropCreateInput | AlertSeasonalCreateInput | AlertDataQualityCreateInput>.

Ответы

Код	Что означает	Тело
201	Created rule	`AlertRule`
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`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`Error`
422	Request failed validation (code=validation_failed)	`Error`

POST /projects/{id}/alerts/seasonal/preview

Replay a seasonal rule over completed project-local days (analyst+)

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

Uses the exact deterministic evaluator used by the worker. The target range is at most 90 completed local days; baseline warm-up remains inside the query engine's 400-day bound. Responses are estimated and carry a permanent `meta.estimate=true` marker. Rate limit is 10/minute per organization with bounded per-org/global concurrency.

Параметры

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

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

Поле	Тип	Описание
`config` обязательно	`SeasonalAlertConfig`
`date_from` обязательно	`string (date)`
`date_to` обязательно	`string (date)`
`cooldown_sec` необязательно	`integer`	По умолчанию `0`.
`limit` необязательно	`integer`	По умолчанию `30`.
`cursor` необязательно	`string`

Ответы

Код	Что означает	Тело
200	Historical deterministic decisions	`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`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`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}/release-markers

List project release markers in a bounded local-date range

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

Параметры

Имя	Где	Тип	Описание
`id` обязателен	Путь	`integer (int32)`	Project id.
`date_from` обязателен	Query	`string (date)`
`date_to` обязателен	Query	`string (date)`
`limit` необязателен	Query	`integer`	По умолчанию `100`.
`cursor` необязателен	Query	`string`

Ответы

Код	Что означает	Тело
200	Release marker page, newest first	`ReleaseMarkerPage`
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`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

POST /projects/{id}/release-markers

Create a manual or authenticated-API release marker (analyst+)

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

`source=deploy` is rejected here and requires a scoped release token.

Параметры

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

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

Поле	Тип	Описание
`name` обязательно	`string`
`description` необязательно	`string`
`ts` необязательно	`string (date-time)`	Defaults to server time for authenticated writes.
`source` необязательно	`enum(manual, api)`	Defaults to manual when omitted.
`version` необязательно	`string`
`env` необязательно	`string`
`link` необязательно	`string (uri)`	Absolute HTTP(S) URL without embedded user credentials.

Ответы

Код	Что означает	Тело
201	Created marker	`ReleaseMarker`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`Error`
422	Request failed validation (code=validation_failed)	`Error`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

GET /projects/{id}/release-markers/{mid}

Get one project release marker

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

Параметры

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

Ответы

Код	Что означает	Тело
200	Release marker	`ReleaseMarker`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

PATCH /projects/{id}/release-markers/{mid}

Update mutable release marker fields (analyst+)

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

Параметры

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

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

Поле	Тип	Описание
`name` необязательно	`string`
`description` необязательно	`string`
`ts` необязательно	`string (date-time)`
`version` необязательно	`string`
`env` необязательно	`string`
`link` необязательно	`string (uri)`	Absolute HTTP(S) URL without embedded user credentials.

Ответы

Код	Что означает	Тело
200	Updated marker	`ReleaseMarker`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`Error`
422	Request failed validation (code=validation_failed)	`Error`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

DELETE /projects/{id}/release-markers/{mid}

Soft-delete a release marker (analyst+)

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

Параметры

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

Ответы

Код	Что означает	Тело
204	Deleted	пусто
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

POST /projects/{id}/release-markers/deploy

Create an idempotent deploy marker from CI/CD

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

Параметры

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

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

Поле	Тип	Описание
`name` обязательно	`string`
`description` необязательно	`string`
`ts` обязательно	`string (date-time)`
`version` необязательно	`string`
`env` необязательно	`string`
`link` необязательно	`string (uri)`	Absolute HTTP(S) URL without embedded user credentials.

Ответы

Код	Что означает	Тело
200	Idempotent replay of an existing marker Заголовки: `Idempotency-Replayed`.	`ReleaseMarker`
201	New deploy marker	`ReleaseMarker`
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`
409	Idempotency key reused with another body	`Error`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`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`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

GET /projects/{id}/release-tokens

List release CI/CD tokens without secrets (admin+)

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

Параметры

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

Ответы

Код	Что означает	Тело
200	Token metadata page	`ReleaseTokenPage`
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`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

POST /projects/{id}/release-tokens

Issue a one-time-visible scoped release token (admin+)

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

Параметры

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

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

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

Ответы

Код	Что означает	Тело
201	Token metadata and one-time plaintext token Заголовки: `Cache-Control`.	`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`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`Error`
422	Request failed validation (code=validation_failed)	`Error`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

POST /projects/{id}/release-tokens/{tid}/revoke

Revoke a release token (admin+; always available for cleanup)

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

Параметры

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

Ответы

Код	Что означает	Тело
200	Revoked token metadata	`ReleaseToken`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

GET /projects/{id}/weekly-digest

Get project weekly-digest opt-in settings

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

Параметры

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

Ответы

Код	Что означает	Тело
200	Current settings; disabled defaults are returned before first save	`WeeklyDigestSettings`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

PUT /projects/{id}/weekly-digest

Opt in/out and configure weekly digest channels (analyst+)

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

Delivery is scheduled for Monday 09:00 in the saved recipient IANA timezone and covers the previous complete local week. Disabling and removing a privileged webhook remain possible after downgrade. Email/Telegram use the existing alerts capability; webhook also requires alerts_webhook.

Параметры

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

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

Поле	Тип	Описание
`enabled` обязательно	`boolean`
`timezone` необязательно	`string`	Recipient IANA timezone. Omitted by older clients to retain the saved value.
`channels` необязательно	`array<oneOf<AlertEmailChannel \| AlertTelegramChannel \| AlertWebhookChannel>>`
`include_revenue` необязательно	`boolean`
`include_rage` необязательно	`boolean`

Ответы

Код	Что означает	Тело
200	Saved settings with secrets masked	`WeeklyDigestSettings`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`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`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

POST /projects/{id}/weekly-digest/preview

Calculate a bounded weekly-digest preview

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

Calculates, but never delivers or records as a run, the previous complete week in the saved recipient IANA timezone. The calculation reuses the scheduled digest metric builder and the saved include_revenue/include_rage flags. It has a 30-second timeout plus per-organization concurrency and rate limits. Estimated and correlational sections are always labelled in both lines and response metadata.

Параметры

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

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

Схема тела: object.

Ответы

Код	Что означает	Тело
200	Preview for the previous complete local week	`WeeklyDigestPreview`
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`
413	Request body exceeds the endpoint-specific byte limit (code=validation_failed)	`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}/weekly-digest/runs

List bounded weekly-digest run history

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

Параметры

Имя	Где	Тип	Описание
`id` обязателен	Путь	`integer (int32)`	Project id.
`date_from` необязателен	Query	`string (date)`	Inclusive local week-start lower bound. Defaults to the last 90 days when both bounds are omitted.
`date_to` необязателен	Query	`string (date)`	Exclusive local week-start upper bound. Required together with date_from and for cursor requests; maximum range is 366 days.
`limit` необязателен	Query	`integer`	По умолчанию `20`.
`cursor` необязателен	Query	`string`

Ответы

Код	Что означает	Тело
200	Durable run page with honest terminal and per-channel states	`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`
422	Request failed validation (code=validation_failed)	`Error`
504	Query exceeded the endpoint-specific timeout (code=query_timeout)	`Error`

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

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