Get Report

curl --request GET \
  --url https://api.userintuition.ai/api/public/v1/studies/{study_id}/report \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.userintuition.ai/api/public/v1/studies/{study_id}/report"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userintuition.ai/api/public/v1/studies/{study_id}/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userintuition.ai/api/public/v1/studies/{study_id}/report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userintuition.ai/api/public/v1/studies/{study_id}/report"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.userintuition.ai/api/public/v1/studies/{study_id}/report")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/studies/{study_id}/report")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "study_id": "<string>",
  "schema_version": "report-v2",
  "structure_status": "legacy_partial",
  "report_id": "<string>",
  "summary": "<string>",
  "summary_truncated": false,
  "included_sections": [
    "<string>"
  ],
  "available_sections": [
    "<string>"
  ],
  "based_on_interview_ids_included": false,
  "references": [
    {
      "reference_id": "<string>",
      "interview_id": "<string>",
      "audio_recording_url": "<string>",
      "video_recording_url": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "duration_seconds": 123,
      "message_text": "<string>",
      "turn_id": "<string>",
      "start_s": 1
    }
  ],
  "study_findings": {
    "executive_summary": {
      "heading": "<string>",
      "content": "",
      "reference_ids": [
        "<string>"
      ]
    },
    "key_metrics": {
      "heading": "<string>",
      "content": "",
      "reference_ids": [
        "<string>"
      ]
    },
    "learning_goals": [
      {
        "learning_goal_id": "<string>",
        "learning_goal": "<string>",
        "findings": [
          {
            "heading": "<string>",
            "finding_id": "<string>",
            "content": "",
            "reference_ids": [
              "<string>"
            ],
            "prevalence": {
              "n": 1,
              "of": 1
            },
            "quotes": [
              {
                "text": "<string>",
                "reference_id": "<string>",
                "interview_id": "<string>",
                "turn_id": "<string>",
                "start_s": 1
              }
            ],
            "supporting_evidence": "<string>",
            "contrary_evidence": "<string>",
            "limitations": "<string>"
          }
        ]
      }
    ],
    "additional_observations": {
      "heading": "<string>",
      "content": "",
      "reference_ids": [
        "<string>"
      ]
    },
    "other_sections": [
      {
        "heading": "<string>",
        "content": "",
        "reference_ids": [
          "<string>"
        ]
      }
    ]
  },
  "participant_profiles": [
    {
      "heading": "<string>",
      "question_id": "<string>",
      "content": [
        {
          "answer": "<string>",
          "participants": 1,
          "percentage": 50
        }
      ],
      "reference_ids": [
        "<string>"
      ]
    }
  ],
  "participant_responses": [
    {
      "interview_id": "<string>",
      "overall_takeaways": [
        "<string>"
      ],
      "learning_goal_responses": [
        {
          "learning_goal_id": "<string>",
          "learning_goal_index": 123,
          "learning_goal": "<string>",
          "assessment_state": "<string>",
          "unavailability_reason": "<string>",
          "explored": true,
          "answered": true,
          "summary": "<string>",
          "quote": "<string>"
        }
      ]
    }
  ],
  "evidence_coverage": {
    "text": "",
    "sample_adequacy": {
      "supports": "<string>",
      "limits": "<string>",
      "additional_interviews": "recommended",
      "rationale": "<string>"
    },
    "learning_goal_evaluations": [
      {
        "goal_id": "<string>",
        "supports": "<string>",
        "limits": "<string>",
        "purpose": "<string>",
        "finding_ids": [
          "<string>"
        ],
        "label": ""
      }
    ],
    "evidence_gaps": [
      {
        "id": "<string>",
        "priority": 123,
        "title": "<string>",
        "description": "<string>",
        "decision_relevance": "<string>",
        "learning_goal_ids": [
          "<string>"
        ],
        "finding_ids": [
          "<string>"
        ],
        "evidence_needed": "",
        "priority_rationale": "",
        "kind": "research",
        "resolution_scope": "not_applicable",
        "required_changes": [
          "<string>"
        ],
        "recommended_study_slug": "in-depth-interview",
        "reference_ids": [
          "<string>"
        ]
      }
    ]
  },
  "recommended_next_steps": [
    {
      "action": "<string>",
      "title": "<string>",
      "rationale": "<string>",
      "gap_ids": [
        "<string>"
      ],
      "study_slug": "<string>",
      "context": "<string>"
    }
  ],
  "recommendation_status": "unavailable",
  "interview_count": 0,
  "based_on_interview_ids": [
    "<string>"
  ],
  "interview_count_basis": "legacy_unverified",
  "is_stale": true,
  "stale_reason": "inputs_changed",
  "new_interviews_since": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "not_started",
    "recovery_action": "<string>",
    "docs_url": "<string>"
  }
}

{
  "detail": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "not_started",
    "recovery_action": "<string>",
    "docs_url": "<string>"
  }
}