Admin APIs
prisms

Preview Prism

Changed on

Compute a prism's data through the real purchase path without touching the public page — so an admin can view the exact platform rendering of a draft (saved or unsaved) before it goes live. Read-through cached here in CAMS; force re-purchases.

post/api/v1/admin/prisms/preview

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/prisms/preview
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Request body

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'
prism_idstring uuid nullable
forceboolean

Response

Successful Response

cachedboolean required
prismobject required

Changes