Sign in
latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
prisms

Update Prism

Update a prism. Live saves recompute only under the 5:00 PM ET / freshness rules (see _should_recompute_on_live_save); copy-only skips re-compose the cached tile (display fields come from the definition, not the compute). Unpublishing drops the tile from the serving cache.

Going live always requires a successful recompute. If refresh fails on a draft→live transition, publish_state is rolled back to draft — a prism never sits live without a computed snapshot. Other field edits from the same request are kept. Already-live edits that fail recompute keep live + last-good tile; the structured error says so.

put/api/v1/admin/prisms/{prism_id}

Path parameters

prism_idstring required

Request body

titlestring nullable
category_idstring uuid nullable
questionstring nullable
question_sharestring nullable
notestring nullable
insight_idinteger nullable
insight_labelstring nullable
location_resolutionstring nullable
filtersobject nullable
publish_state'draft' | 'live'

Response

Successful Response

titlestring required

Prism name

category_idstring uuid required

First-class category (prism_categories.id)

questionstring nullable

Question this prism answers in the growth (index) view

question_sharestring nullable

Question this prism answers in the share view

notestring nullable

Short caveat shown as a warning bar at the top of this prism's drawer on the public page. Null/blank = no bar.

insight_idinteger required

Metric insight id

insight_labelstring required
location_resolutionstring

Location grain the framework computes at, as advertised by /prisms/location-resolutions for this insight + entity set

filtersobject

Dimension filters from the framework's advertised set, as {filter_key: value}. Blank selections are dropped, not sent as empty lists. Grain / window / aggregate are prism-owned and rejected here.

publish_state'draft' | 'live'
idstring uuid required
categorystring required
archived_atstring date-time nullable
last_refreshed_atstring date-time nullable
last_order_idstring nullable
created_atstring date-time required
updated_atstring date-time required
created_bystring nullable
date_window_startstring date required
date_window_endstring date required