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

API: SecureSharing

Expiring read-only report/dashboard links and scheduled delivery.

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

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

Методы раздела
POST /api/public/shares/resolve

Resolve a fragment bearer into a typed read-only view

Аутентификация
Без аутентификации
operationId
postPublicSharesResolve
Базовый адрес
/

The SPA reads the pps_ token from location.hash and sends it only in this bounded POST body. Responses are no-store/no-referrer/frame-denied. Invalid, expired and revoked links are concealed; attempts are rate-limited by source IP and token fingerprint and are mandatory-audited.

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

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

Ответы

Код Что означает Тело
200 Safe read-only aggregate 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
413 Body exceeds 1 KiB 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}/share-delivery-schedules

Create a daily secure-link delivery schedule (analyst+)

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

Email or Telegram destination is server-validated, encrypted transport configuration stays internal, and the response never echoes destination. The existing worker scheduler/notifier executes bounded leased occurrences.

Параметры

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

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

Поле Тип Описание
target_type обязательно enum(report, dashboard)
target_id обязательно integer (int64)
channel обязательно enum(email, telegram)
destination обязательно string Server-validated and never echoed
timezone обязательно string
local_hour обязательно integer
local_minute обязательно integer
link_ttl_seconds обязательно integer

Ответы

Код Что означает Тело
201 Schedule created 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
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}/share-delivery-schedules/{scheduleID}/deliveries

List bounded delivery history (analyst+)

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

Параметры

Имя Где Тип Описание
id обязателен Путь integer (int32) Project id.
scheduleID обязателен Путь string (uuid) Secure delivery schedule UUID.
from обязателен Query string (date-time) Inclusive UTC lower bound.
to обязателен Query string (date-time) Inclusive UTC upper bound; range is bounded server-side.
cursor необязателен Query string Scope-bound opaque cursor
limit необязателен Query integer По умолчанию 50.

Ответы

Код Что означает Тело
200 Delivery history page ShareDeliveryPage
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
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}/shares

Create an expiring secure read-only link (analyst+)

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

Requires the draft secure_sharing backend entitlement. SQL reports and dashboards containing SQL are rejected. The 256-bit bearer appears once, only in the URL fragment; PostgreSQL stores only its SHA-256 digest.

Параметры

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

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

Поле Тип Описание
target_type обязательно enum(report, dashboard)
target_id обязательно integer (int64)
expires_at обязательно string (date-time) At least 5 minutes and at most 365 days in the future.
password необязательно string
watermark необязательно string

Ответы

Код Что означает Тело
201 Link created; response and URL must never be cached/logged 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
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}/shares/{sid}/revoke

Revoke a project-scoped secure link (analyst+)

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

Параметры

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

Ответы

Код Что означает Тело
200 Link revoked idempotently 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
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