Skip to content

List insights. Pagination applies only to root elements (ScenarioId == null). When fetching a page, include all children of those roots. Search/filtering applies to both parent and children: If a parent matches, return the parent with all its children. If a child matches, return the child and its parent (even if the parent wouldn’t match by itself).

Request

Page size defaults to 10 when not supplied, and is capped at 1000. It bounds root insights only; children of those roots are also returned.

Security
oauth2
Query
addFloorboolean

When true, the response includes the floorId.

Default:false
Bodyrequired

Filter and sort specifications.

sortSpecificationsArray of objects(SortSpecification)
filterSpecificationsArray of objects(FilterSpecification)
pagenull or integer, (int32)
pageSizenull or integer, (int32)
{ "sortSpecifications": [ { … } ], "filterSpecifications": [ { … } ], "page": null, "pageSize": null }

Responses

A paginated list of insights.

Bodyapplication/json
beforeinteger, (int32)
afterinteger, (int32)
totalinteger, (int32)
itemsArray of objects(Insight)
Response
{ "before": 0, "after": 0, "total": 0, "items": [ { … } ] }