Overview

Home "Insights" card (top active recommendations)

Returns the Home "Insights" card: the top 5 active, non-dismissed, non-suppressed recommendations (engine ranking, presented newest first), gated by the insights-readiness rule — available: false with the unmet readiness-requirement id as reason until the books support trustworthy output. Recommendations are company-scoped facts today: an entityId is honored only when it is the company's ONLY non-group legal entity; otherwise entity_scope_unavailable is reported rather than silently company-widening.

get/companies/{companyId}/insights/home

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/insights/home
  • Auth: HTTP bearer

Query parameters

entityIdstring uuid

Optional concrete legal-entity scope for entity-scopable Home reads. Omitted means company-wide; when present it must be a legal entity the actor is authorized to read (the raw value is never trusted).

Response

Home insights payload

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.