Ontology

Get Builder Bootstrap

Changed on

Everything the builder needs on first paint, in one request.

Unscoped this is the catalog landing. Scoped it is the first paint of a counterpart browse -- pass insight_ids when an Insight selection is stepping into entities, entity_id when an Entity is stepping into insights -- which collapses that transition's list, count tree and taxonomy calls into the same single request the landing already uses.

get/v2/ontology/builder

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/ontology/builder
  • Auth: none declared

Query parameters

sectionsstring[] nullable

Sections to include. Omit for all of: topics, categories, event_categories, entities_count_tree, entities, insights, all_insights, featured

pageinteger

Page for the paginated sections

sizeinteger

Page size for the paginated sections

sort_bystring nullable

Sort key for the paginated sections. Predates this endpoint serving two lists at once: prefer entities_sort_by / insights_sort_by, which are validated per section. A key from the other section's vocabulary is ignored for that section.

entities_sort_bystring nullable

Sort key for the entities section. Wins over sort_by.

insights_sort_bystring nullable

Sort key for the insights section. Wins over sort_by.

orderstring nullable

Sort direction

insight_idsinteger[] nullable

Scope the entities section to entities carrying every one of these insights. Same semantics as GET /v2/ontology/entities.

entity_idinteger nullable

Scope the insights section to this entity

entity_representationstring nullable

Representation for entity_id

event_idinteger nullable

Scope both list sections to this event

event_representationstring nullable

Representation for event_id

event_category_idinteger nullable

Scope both list sections to this event category

entitystring[] nullable

Entity core filter for the entity-facing sections

entity_domainstring[] nullable

Entity domain filter for the entities section

featured_entitiesstring nullable

base64url featured-entity pins for the entities section. Omit to use the curated list power-api holds; pass a value to override it.

Request body

object nullable required

Response

Successful Response

sectionsobject required

Changes