API: Diagnostics
JavaScript error and Web Vitals reports; impact/correlation values are estimates.
На этой странице
Раздел собран из спецификации OpenAPI продукта: 4 метод(ов). Поверхность — query-api (основной API, база /api/v1). Все методы требуют аутентификации.
Методы раздела
GET
/projects/{id}/diagnostics/errors Group JavaScript errors by sanitized stack hash (viewer+)
If dates are omitted the latest 30 local calendar days are used; supplied dates are inclusive and limited to 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. |
cursor необязателен | Query | string | Opaque cursor bound to project and the complete effective query scope. |
limit необязателен | Query | integer | По умолчанию 50. |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 200 | Cursor-paginated error groups. | DiagnosticErrorsPage |
| 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 |
POST
/projects/{id}/diagnostics/errors/impact Estimate conversion lift associated with one JavaScript error (viewer+)
Reuses the selected funnel's project timezone, date window, exact step filters, identity and deduplication semantics. Supports 2..10 steps, actors counting and a 1..2160 hour funnel window. Breakdown, drill-down transport and saved-segment references are rejected. `meta.estimate` is always true and must remain visibly labelled in clients.
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
id обязателен | Путь | integer (int32) | Project id. |
Тело запроса application/json , обязательно
| Поле | Тип | Описание |
|---|---|---|
stack_hash обязательно | string | |
funnel обязательно | DiagnosticFunnelRequest |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 200 | Exposed/unexposed cohort rates and estimated lift. | DiagnosticImpactResponse |
| 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}/diagnostics/vitals List Web Vitals p75 metrics by URL (viewer+)
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
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. |
cursor необязателен | Query | string | Opaque cursor bound to project and the complete effective query scope. |
limit необязателен | Query | integer | По умолчанию 50. |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 200 | Cursor-paginated URL vitals. | DiagnosticVitalsPage |
| 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 |
POST
/projects/{id}/diagnostics/vitals/correlation Estimate session LCP/conversion correlation for one URL (viewer+)
Uses session-level samples over an inclusive project-timezone range of at most 400 days. `meta.estimate` is always true and must remain visibly labelled in clients; correlation is not causation.
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
id обязателен | Путь | integer (int32) | Project id. |
Тело запроса application/json , обязательно
| Поле | Тип | Описание |
|---|---|---|
date_from обязательно | string (date) | |
date_to обязательно | string (date) | |
url обязательно | string | |
conversion_event обязательно | string |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 200 | Estimated Pearson correlation and fast/slow conversion rates. | DiagnosticCorrelationResponse |
| 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 |
Источник раздела — docs/api/openapi.yaml репозитория продукта,
версия API 1.0.0, OpenAPI 3.0.3,
снимок 095579325c2d.
Расхождение снимка со спецификацией роняет сборку документации.