List insights

Returns the insights on a Book. The insights are split into two groups: ocrolus_insights and aus_insights. To learn more about insights and how they are relate to conditions, see the Insights guide.

📘

Note

  • Requires read access to the Book.
  • A Book with no insights returns empty arrays, not an error.
  • The response is not paginated. Every insight on the Book is returned.
  • AUS findings are returned only when include_aus=true, and only for organizations with AUS ingestion enabled.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the Book.

Query Params
string
enum

Return only insights with this status. Applies to both groups. Accepted values are "Active", "Resolved", or "Discarded" (matching is case-insensitive).

Allowed:
boolean
Defaults to false

Include AUS DU and LPA findings. When false, the aus_insights key is omitted from the response entirely.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json