> ## Documentation Index
> Fetch the complete documentation index at: https://docs.userintuition.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Report

> Read the latest persisted report. Choose an overview, one section, or the full report with view.



## OpenAPI

````yaml /api-reference/openapi.json get /api/public/v1/studies/{study_id}/report
openapi: 3.1.0
info:
  title: User Intuition Public API
  description: >-
    ## Public Integration API


    Programmatic access to User Intuition for external integrators: manage
    studies, participants, interviews, reports, and panels.


    ### Authentication


    All endpoints require a Bearer token — either an API key (prefixed `ui_sk_`,
    created in the dashboard) or a dashboard JWT:


    ```

    Authorization: Bearer <ui_sk_… or JWT>

    ```


    ### Base URLs


    - **Production:** `https://api.userintuition.ai`

    - **Staging:** `https://staging.userintuition.ai`


    ### Support


    For API support, contact support@userintuition.ai
  version: 1.0.0
  contact:
    name: User Intuition Support
    email: support@userintuition.ai
servers:
  - url: https://api.userintuition.ai
    description: Production
  - url: https://staging.userintuition.ai
    description: Staging
security:
  - BearerAuth: []
paths:
  /api/public/v1/studies/{study_id}/report:
    get:
      tags:
        - public-studies
      summary: Get Report
      description: >-
        Read the latest persisted report. Choose an overview, one section, or
        the full report with view.
      operationId: getStudyReport
      parameters:
        - name: study_id
          in: path
          required: true
          schema:
            type: string
            title: Study Id
          example: 11111111-2222-3333-4444-555555555555
        - name: view
          in: query
          required: false
          schema:
            enum:
              - overview
              - full
              - references
              - study_findings
              - participant_profiles
              - participant_responses
              - evidence_coverage
              - recommended_next_steps
            type: string
            description: overview (default), full, or one report section
            default: overview
            title: View
          description: overview (default), full, or one report section
          example: study_findings
        - name: X-UI-Organization-ID
          in: header
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 128
              - type: 'null'
            description: >-
              Platform admins only: choose an organization for scoped reads and
              writes. Required to change another organization's study or use its
              wallet.
            title: X-Ui-Organization-Id
          description: >-
            Platform admins only: choose an organization for scoped reads and
            writes. Required to change another organization's study or use its
            wallet.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicReport'
        '422':
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        default:
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
components:
  schemas:
    PublicReport:
      properties:
        schema_version:
          type: string
          const: report-v2
          title: Schema Version
          default: report-v2
        structure_status:
          type: string
          enum:
            - structured
            - legacy_partial
          title: Structure Status
          description: >-
            Whether learning-goal findings can be joined to the saved evidence
            snapshot
          default: legacy_partial
        report_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Report Id
          description: Persisted report ID
        study_id:
          type: string
          title: Study Id
          description: The study this report was generated for
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
          description: Short executive summary in overview responses
        summary_truncated:
          type: boolean
          title: Summary Truncated
          default: false
        included_sections:
          items:
            type: string
          type: array
          title: Included Sections
        available_sections:
          items:
            type: string
          type: array
          title: Available Sections
        based_on_interview_ids_included:
          type: boolean
          title: Based On Interview Ids Included
          default: false
        references:
          items:
            $ref: '#/components/schemas/PublicReportReference'
          type: array
          title: References
        study_findings:
          $ref: '#/components/schemas/PublicStudyFindings'
        participant_profiles:
          items:
            $ref: '#/components/schemas/PublicReportParticipantProfileSection'
          type: array
          title: Participant Profiles
          description: >-
            Participant-profile questions with stable question IDs and
            answer/count/percentage arrays
        participant_responses:
          items:
            $ref: '#/components/schemas/PublicParticipantResponse'
          type: array
          title: Participant Responses
        evidence_coverage:
          $ref: '#/components/schemas/PublicEvidenceCoverage'
        recommended_next_steps:
          items:
            $ref: '#/components/schemas/PublicRecommendedNextStep'
          type: array
          title: Recommended Next Steps
        recommendation_status:
          type: string
          enum:
            - available
            - partial
            - unavailable
          title: Recommendation Status
          default: unavailable
        interview_count:
          type: integer
          title: Interview Count
          description: Number of interviews included in the report
          default: 0
        based_on_interview_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Based On Interview Ids
          description: >-
            Interview IDs included in the saved report evidence; null when
            unavailable for a legacy report
        interview_count_basis:
          type: string
          enum:
            - saved_evidence
            - legacy_unverified
          title: Interview Count Basis
          default: legacy_unverified
        is_stale:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Stale
          description: >-
            True if the report's inputs drifted since it was generated
            (regenerate to refresh); None = unknown
        stale_reason:
          anyOf:
            - type: string
              enum:
                - inputs_changed
                - fingerprint_unavailable
                - comparison_unavailable
            - type: 'null'
          title: Stale Reason
        new_interviews_since:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: New Interviews Since
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - study_id
      title: PublicReport
    PublicApiErrorResponse:
      type: object
      required:
        - detail
        - error
      properties:
        detail:
          description: Legacy error detail; may be a string, list, or object.
        error:
          $ref: '#/components/schemas/PublicApiError'
    PublicReportReference:
      properties:
        reference_id:
          type: string
          title: Reference Id
          description: Citation id used in the report text
        interview_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Interview Id
          description: The interview this reference quotes
        audio_recording_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Audio Recording Url
        video_recording_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Video Recording Url
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
          description: When the interview started
        duration_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration Seconds
          description: Interview length in seconds
        message_text:
          anyOf:
            - type: string
            - type: 'null'
          title: Message Text
          description: The quoted message text
        turn_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Turn Id
          description: Transcript turn ID, when available
        start_s:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
          title: Start S
          description: Seconds into the interview, when stored timing exists
      type: object
      required:
        - reference_id
      title: PublicReportReference
      description: A citation in the report, resolved to the interview + message it quotes.
    PublicStudyFindings:
      properties:
        executive_summary:
          anyOf:
            - $ref: '#/components/schemas/PublicReportSection'
            - type: 'null'
        key_metrics:
          anyOf:
            - $ref: '#/components/schemas/PublicReportSection'
            - type: 'null'
        learning_goals:
          items:
            $ref: '#/components/schemas/PublicLearningGoalFindings'
          type: array
          title: Learning Goals
        additional_observations:
          anyOf:
            - $ref: '#/components/schemas/PublicReportSection'
            - type: 'null'
        other_sections:
          items:
            $ref: '#/components/schemas/PublicReportSection'
          type: array
          title: Other Sections
      type: object
      title: PublicStudyFindings
    PublicReportParticipantProfileSection:
      properties:
        heading:
          type: string
          title: Heading
        content:
          items:
            $ref: '#/components/schemas/PublicParticipantProfileAnswer'
          type: array
          title: Content
        reference_ids:
          items:
            type: string
          type: array
          title: Reference Ids
        question_id:
          type: string
          title: Question Id
          description: Stable identifier derived from the profile question heading
      type: object
      required:
        - heading
        - question_id
      title: PublicReportParticipantProfileSection
    PublicParticipantResponse:
      properties:
        interview_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Interview Id
          description: Public interview record ID
        overall_takeaways:
          items:
            type: string
          type: array
          title: Overall Takeaways
        learning_goal_responses:
          items:
            $ref: '#/components/schemas/PublicParticipantLearningGoalResponse'
          type: array
          title: Learning Goal Responses
      type: object
      title: PublicParticipantResponse
    PublicEvidenceCoverage:
      properties:
        text:
          type: string
          title: Text
          default: ''
        sample_adequacy:
          anyOf:
            - $ref: '#/components/schemas/SampleAdequacy'
            - type: 'null'
        learning_goal_evaluations:
          items:
            $ref: '#/components/schemas/GoalAssessment'
          type: array
          title: Learning Goal Evaluations
        evidence_gaps:
          items:
            $ref: '#/components/schemas/PublicEvidenceGap'
          type: array
          title: Evidence Gaps
      type: object
      title: PublicEvidenceCoverage
    PublicRecommendedNextStep:
      properties:
        gap_ids:
          items:
            type: string
          type: array
          title: Gap Ids
        action:
          type: string
          title: Action
        study_slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Slug
        title:
          type: string
          title: Title
        rationale:
          type: string
          title: Rationale
        context:
          anyOf:
            - type: string
            - type: 'null'
          title: Context
      type: object
      required:
        - action
        - title
        - rationale
      title: PublicRecommendedNextStep
    PublicApiError:
      type: object
      required:
        - code
        - message
        - field
        - request_id
        - outcome
        - recovery_action
        - docs_url
      properties:
        code:
          type: string
        message:
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
        request_id:
          type: string
          format: uuid
        outcome:
          type: string
          enum:
            - not_started
            - failed
            - unknown
        recovery_action:
          type: string
        docs_url:
          type: string
          format: uri
    PublicReportSection:
      properties:
        heading:
          type: string
          title: Heading
        content:
          type: string
          title: Content
          default: ''
        reference_ids:
          items:
            type: string
          type: array
          title: Reference Ids
          description: Citation IDs that resolve through the report's references array
      type: object
      required:
        - heading
      title: PublicReportSection
    PublicLearningGoalFindings:
      properties:
        learning_goal_id:
          type: string
          title: Learning Goal Id
        learning_goal:
          type: string
          title: Learning Goal
        findings:
          items:
            $ref: '#/components/schemas/PublicStudyFinding'
          type: array
          title: Findings
      type: object
      required:
        - learning_goal_id
        - learning_goal
      title: PublicLearningGoalFindings
    PublicParticipantProfileAnswer:
      properties:
        answer:
          type: string
          title: Answer
        participants:
          type: integer
          minimum: 0
          title: Participants
        percentage:
          type: integer
          maximum: 100
          minimum: 0
          title: Percentage
      type: object
      required:
        - answer
        - participants
        - percentage
      title: PublicParticipantProfileAnswer
    PublicParticipantLearningGoalResponse:
      properties:
        learning_goal_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Learning Goal Id
        learning_goal_index:
          anyOf:
            - type: integer
            - type: 'null'
          title: Learning Goal Index
        learning_goal:
          anyOf:
            - type: string
            - type: 'null'
          title: Learning Goal
        assessment_state:
          anyOf:
            - type: string
            - type: 'null'
          title: Assessment State
        unavailability_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Unavailability Reason
        explored:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Explored
        answered:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Answered
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
        quote:
          anyOf:
            - type: string
            - type: 'null'
          title: Quote
      type: object
      title: PublicParticipantLearningGoalResponse
    SampleAdequacy:
      properties:
        supports:
          type: string
          minLength: 1
          title: Supports
        limits:
          type: string
          minLength: 1
          title: Limits
        additional_interviews:
          type: string
          enum:
            - recommended
            - not_prioritized
            - conditional
          title: Additional Interviews
        rationale:
          type: string
          minLength: 1
          title: Rationale
      type: object
      required:
        - supports
        - limits
        - additional_interviews
        - rationale
      title: SampleAdequacy
    GoalAssessment:
      properties:
        goal_id:
          type: string
          title: Goal Id
        finding_ids:
          items:
            type: string
          type: array
          title: Finding Ids
        label:
          type: string
          title: Label
          default: ''
        supports:
          type: string
          minLength: 1
          title: Supports
        limits:
          type: string
          minLength: 1
          title: Limits
        purpose:
          type: string
          minLength: 1
          title: Purpose
      type: object
      required:
        - goal_id
        - supports
        - limits
        - purpose
      title: GoalAssessment
    PublicEvidenceGap:
      properties:
        id:
          type: string
          title: Id
        priority:
          type: integer
          title: Priority
        title:
          type: string
          title: Title
        learning_goal_ids:
          items:
            type: string
          type: array
          title: Learning Goal Ids
        finding_ids:
          items:
            type: string
          type: array
          title: Finding Ids
        description:
          type: string
          title: Description
        decision_relevance:
          type: string
          title: Decision Relevance
        evidence_needed:
          type: string
          title: Evidence Needed
          default: ''
        priority_rationale:
          type: string
          title: Priority Rationale
          default: ''
        kind:
          type: string
          enum:
            - research
            - operational
          title: Kind
          default: research
        resolution_scope:
          type: string
          enum:
            - same_plan_more_interviews
            - new_study
            - not_applicable
          title: Resolution Scope
          default: not_applicable
        required_changes:
          items:
            type: string
          type: array
          title: Required Changes
        recommended_study_slug:
          anyOf:
            - type: string
              enum:
                - in-depth-interview
                - concept-test
                - prototype-test
            - type: 'null'
          title: Recommended Study Slug
        reference_ids:
          items:
            type: string
          type: array
          title: Reference Ids
      type: object
      required:
        - id
        - priority
        - title
        - description
        - decision_relevance
      title: PublicEvidenceGap
    PublicStudyFinding:
      properties:
        heading:
          type: string
          title: Heading
        content:
          type: string
          title: Content
          default: ''
        reference_ids:
          items:
            type: string
          type: array
          title: Reference Ids
          description: Citation IDs that resolve through the report's references array
        finding_id:
          type: string
          title: Finding Id
        prevalence:
          anyOf:
            - $ref: '#/components/schemas/PublicFindingPrevalence'
            - type: 'null'
        quotes:
          items:
            $ref: '#/components/schemas/PublicFindingQuote'
          type: array
          title: Quotes
        supporting_evidence:
          anyOf:
            - type: string
            - type: 'null'
          title: Supporting Evidence
        contrary_evidence:
          anyOf:
            - type: string
            - type: 'null'
          title: Contrary Evidence
        limitations:
          anyOf:
            - type: string
            - type: 'null'
          title: Limitations
      type: object
      required:
        - heading
        - finding_id
      title: PublicStudyFinding
    PublicFindingPrevalence:
      properties:
        'n':
          type: integer
          minimum: 0
          title: 'N'
        of:
          type: integer
          minimum: 0
          title: Of
      type: object
      required:
        - 'n'
        - of
      title: PublicFindingPrevalence
    PublicFindingQuote:
      properties:
        text:
          type: string
          title: Text
        reference_id:
          type: string
          title: Reference Id
        interview_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Interview Id
        turn_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Turn Id
        start_s:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
          title: Start S
      type: object
      required:
        - text
        - reference_id
      title: PublicFindingQuote
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.