Skip to main content
GET
Get Report

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

X-UI-Organization-ID
string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Path Parameters

study_id
string
required

Query Parameters

view
enum<string>
default:overview

overview (default), full, or one report section

Available options:
overview,
full,
references,
study_findings,
participant_profiles,
participant_responses,
evidence_coverage,
recommended_next_steps

Response

Successful Response

study_id
string
required

The study this report was generated for

schema_version
string
default:report-v2
Allowed value: "report-v2"
structure_status
enum<string>
default:legacy_partial

Whether learning-goal findings can be joined to the saved evidence snapshot

Available options:
structured,
legacy_partial
report_id
string | null

Persisted report ID

summary
string | null

Short executive summary in overview responses

summary_truncated
boolean
default:false
included_sections
string[]
available_sections
string[]
based_on_interview_ids_included
boolean
default:false
references
PublicReportReference · object[]
study_findings
PublicStudyFindings · object
participant_profiles
PublicReportParticipantProfileSection · object[]

Participant-profile questions with stable question IDs and answer/count/percentage arrays

participant_responses
PublicParticipantResponse · object[]
evidence_coverage
PublicEvidenceCoverage · object
recommendation_status
enum<string>
default:unavailable
Available options:
available,
partial,
unavailable
interview_count
integer
default:0

Number of interviews included in the report

based_on_interview_ids
string[] | null

Interview IDs included in the saved report evidence; null when unavailable for a legacy report

interview_count_basis
enum<string>
default:legacy_unverified
Available options:
saved_evidence,
legacy_unverified
is_stale
boolean | null

True if the report's inputs drifted since it was generated (regenerate to refresh); None = unknown

stale_reason
enum<string> | null
Available options:
inputs_changed,
fingerprint_unavailable,
comparison_unavailable
new_interviews_since
integer | null
Required range: x >= 0
created_at
string<date-time> | null
updated_at
string<date-time> | null