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

API: Dashboards

Dashboards and their widgets, plus on-demand refresh.

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

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

Методы раздела
GET /dashboards/{did}

Get a dashboard

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

Параметры

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

Ответы

Код Что означает Тело
200 Dashboard Dashboard
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
PATCH /dashboards/{did}

Rename a dashboard (analyst+)

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

Параметры

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

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

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

Ответы

Код Что означает Тело
200 Updated dashboard Dashboard
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 /dashboards/{did}

Delete a dashboard (analyst+)

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

Параметры

Имя Где Тип Описание
did обязателен Путь integer (int64) Dashboard 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 /dashboards/{did}/refresh

Execute all widget reports and return their results (project member)

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

Each saved report is authorized against the current plan at execution time. After a downgrade, a widget using segment:{id} or dropped_at_step returns error_code=feature_locked, feature_locked_trial or subscription_required and no result; other Start-compatible widgets in the same refresh continue normally.

Параметры

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

Ответы

Код Что означает Тело
200 Per-widget refresh results 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
GET /dashboards/{did}/widgets

List a dashboard's widgets

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

Параметры

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

Ответы

Код Что означает Тело
200 Widgets object
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
POST /dashboards/{did}/widgets

Add a widget bound to a report (analyst+)

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

Параметры

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

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

Поле Тип Описание
report_id обязательно integer (int64)
layout необязательно object Grid layout {x,y,w,h}
refresh_sec необязательно integer

Ответы

Код Что означает Тело
201 Created widget Widget
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
PATCH /dashboards/{did}/widgets/{wid}

Update a widget's layout/refresh (analyst+)

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

Параметры

Имя Где Тип Описание
did обязателен Путь integer (int64) Dashboard id.
wid обязателен Путь integer (int64) Widget id.

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

Поле Тип Описание
layout необязательно object
refresh_sec необязательно integer

Ответы

Код Что означает Тело
200 Updated widget Widget
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 /dashboards/{did}/widgets/{wid}

Delete a widget (analyst+)

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

Параметры

Имя Где Тип Описание
did обязателен Путь integer (int64) Dashboard id.
wid обязателен Путь integer (int64) Widget 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 /projects/{id}/dashboards

List dashboards in a project

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

Параметры

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

Ответы

Код Что означает Тело
200 Dashboards object
401 Missing or invalid credentials (code=unauthorized) Error
404 Resource not found (code=not_found) Error
POST /projects/{id}/dashboards

Create a dashboard (analyst+)

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

Параметры

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

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

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

Ответы

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

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

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