Admin APIs
prisms

Create Prism

Changed on

Create a prism. A live prism is computed immediately through the real purchase path; if that fails (e.g. provider restriction) nothing is kept, so a tile never exists without data behind it.

post/api/v1/admin/prisms

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
  • 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'

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

  • d1966b531e25Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status