API: Reports

Saved reports (funnel / retention / segmentation / sql configs).

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

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

GET /projects/{id}/reports
POST /projects/{id}/reports
GET /reports/{rid}
PATCH /reports/{rid}
DELETE /reports/{rid}
POST /reports/{rid}/favorite

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

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

GET /projects/{id}/reports
POST /projects/{id}/reports
GET /reports/{rid}
PATCH /reports/{rid}
DELETE /reports/{rid}
POST /reports/{rid}/favorite

GET /projects/{id}/reports

List saved reports in a project

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

Параметры

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

Ответы

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

POST /projects/{id}/reports

Create a saved report (analyst+)

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

Параметры

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

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

Ответы

Код	Что означает	Тело
201	Created report	`Report`
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`

GET /reports/{rid}

Get a saved report

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

Параметры

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

Ответы

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

PATCH /reports/{rid}

Update a saved report (analyst+)

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

Параметры

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

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

Поле	Тип	Описание
`name` необязательно	`string`
`config` необязательно	`anyOf<FunnelReportConfig \| RetentionReportConfig \| SegmentationReportConfig \| PathsReportConfig \| oneOf<CorrelationsReportConfig \| LifecycleReportConfig \| StickinessReportConfig \| ActivationDriversReportConfig> \| SQLReportConfig>`
`is_favorite` необязательно	`boolean`

Ответы

Код	Что означает	Тело
200	Updated report	`Report`
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`

DELETE /reports/{rid}

Delete a saved report (analyst+)

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

Параметры

Имя	Где	Тип	Описание
`rid` обязателен	Путь	`integer (int64)`	Saved report 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`

POST /reports/{rid}/favorite

Toggle/set a report's favorite flag (analyst+)

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

Параметры

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

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

Поле	Тип	Описание
`is_favorite` необязательно	`boolean`	Omit body to set favorite=true

Ответы

Код	Что означает	Тело
200	Updated report	`Report`
401	Missing or invalid credentials (code=unauthorized)	`Error`
403	Authenticated but not permitted (code=forbidden)	`Error`
404	Resource not found (code=not_found)	`Error`

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

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