CAcarbonarc
Ontology

Get Insights List

Changed on

Fetch insights, with pagination. Optimized for new builder workflow - only entity_id is required for filtering. When event_id is provided, only insights linked to that event are returned. When search + event_id are both provided, ES insight search is used treating event_id as entity_id and event_representation as entity_representation.

get/v2/ontology/insights

Request

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

Query parameters

entity_idinteger nullable

Entity ID

entity_representationstring nullable

Entity Representation

entitystring nullable

Entity Filter

subject_idsinteger[] nullable

Subject IDs

topic_idsinteger[] nullable

Topic IDs

insight_typesstring[] nullable

Insight types

dataset_idsstring[] nullable

Dataset IDs

event_idinteger nullable

Filter insights to those linked to this event (carc_id of an event EntityRepresentation). ANDed with entity_id/entity_representation when both are provided.

event_representationstring nullable

Representation type of the event node (e.g. 'corpeventc'). Used alongside event_id to uniquely scope the event. When search is also provided, passed as entity_representation to ES.

event_category_idinteger nullable

Filter insights to those linked to events of this category (carc_id of an EventCategory node).

searchstring nullable

Search term

include_metadataboolean

Include full metadata (descriptions, timestamps, delay status)

min_scorenumber

Minimum search score, between 0 and 1

pageinteger

Page number for insights list

sizeinteger

Number of insights per page

sort_bystring nullable

Field to sort insights by (currently only 'label' is supported)

orderstring

Sort direction (asc/desc)

rand_seedstring nullable

Random seed for featured items

featured_insight_idsinteger[] nullable

Featured insight IDs

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes