Sign in
Admin APIs
prisms

Archive Prism

Archive a prism.

Removes it from the public page and hides it from admin lists / recompute, but keeps the definition row and append-only compute/attempt audit trail.

post/api/v1/admin/prisms/{prism_id}/archive

Path parameters

prism_idstring required

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

Changes

Changed in 1 of the 4 revisions of this API.1

  • d1966b531e251See the full diff
    • ○

      added the optional property note to the response with the 200 status

      response-optional-property-added