Skip to main content
GET
/
api
/
public
/
v1
/
studies
/
{study_id}
/
report
Get Report
curl --request GET \
  --url https://api.userintuition.ai/api/public/v1/studies/{study_id}/report \
  --header 'Authorization: Bearer <token>'
{
  "study_id": "<string>",
  "html": "<string>",
  "interview_count": 0,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
study_id
string
required

Response

Successful Response

​
study_id
string
required

The study this report was generated for

​
html
string | null

Rendered report HTML

​
interview_count
integer
default:0

Number of interviews included in the report

​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null