Widgets API

Auto-generated from openapi-snapshot.json. Do not edit by hand — changes are overwritten by scripts/docs/generate_api_reference.py.

5 endpoints in this group.

GET /api/v1/widgets/visibility

List Visibility

List the current user effective widget visibility rows.

Returns only rows the user has explicitly set. Callers merge registry defaults client-side (see _defaultRow in blitzpulse-web/src/hooks/useWidgetVisibility.ts).

Responses

DELETE /api/v1/widgets/visibility/{widget_id}

Delete Visibility

Drop the user override for widget_id; reverts to registry defaults.

Parameters

Responses

PUT /api/v1/widgets/visibility/{widget_id}

Upsert Visibility

Upsert the user visibility row for widget_id (partial update).

Parameters

Request body: application/json

Responses

PATCH /api/v1/widgets/visibility/{widget_id}/collapsed

Patch Collapsed

Shortcut PATCH for the frontend widgetsApi.setCollapsed client.

Parameters

Request body: application/json

Responses

PATCH /api/v1/widgets/visibility/{widget_id}/position

Patch Position

Shortcut PATCH for the frontend widgetsApi.setPosition client.

Parameters

Request body: application/json

Responses