Sign in
Prisms

Get Prism

Changed on

One prism at its current published snapshot.

The same numbers the public prisms page is showing for it right now, out of the same composition, so the two can never disagree about a prism's values. They can disagree about whether a prism appears at all, either way, and only through a stale cache: a first publish whose write failed is missing from the page but found here, and an unpublish whose delete was swallowed is still on the page but 404s here. Both lean the safe way - serve a live prism, hide an unpublished one. Prism ids come from GET /v2/prisms/catalog or from the filtered list above.

data_through, not the window end, is what says how current the numbers are: it is the last day of real data in the series and it lags when upstream sources are behind.

404 covers three states deliberately: no such prism, a draft or archived one, and a live one that has never published. Only the first is really "not found", but separating them would confirm that unpublished operator work exists.

get/v2/prisms/{prism_id}

Request

  • Base URL: https://api.carbonarc.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.carbonarc.co/v2/prisms/{prism_id}
  • Auth: none declared

Path parameters

prism_idstring uuid required

Response

Successful Response

prism_idstring required
titlestring required
categorystring required
questionstring nullable

Question this prism answers in the growth (index) view

question_sharestring nullable

Question this prism answers in the share view

notestring nullable

Operator caveat shown on the public drawer; usually null

insight_idinteger required
insight_labelstring required
published_atstring date-time nullable

When this prism first went public

data_throughstring date nullable

Last day of real data in the series. Lags today when upstream sources are behind, so this - not the window end - is what says how current the numbers are.

windowobject nullable

Charted span as {start, end}

entitiesobject[]

Per-entity relative series. mtd_yoy / mtd_share by day of the latest month with data; hist_yoy / hist_share by month over the charted year. Year-over-year index levels and share-of-group percentages only, never absolute figures.

frameworkobject nullable

The framework that reproduces this prism, ready to purchase as-is. Keyed for buying rather than reading, so its entities are carc_id / representation, not the entity_id / entity_representation used by the series above. date_range is the compute window behind those series, which is wider than the charted window. Authenticated callers only: the public payload withholds filters.

Changes