API Reference
Get a study readout
The study's synthesized readout: objective, open questions, a narrative summary with stats, and the themes that emerged with representative quotes.
GET
/v1/studies/{studyId}/readoutExample
curl -X GET "https://example.com/v1/studies/string/readout" \ -H "Authorization: Bearer $ASKENGINE_API_KEY"Response
{ "data": { "studyId": "std_789", "name": "Onboarding interviews Q4", "status": "active", "objective": "Understand where new teams stall in their first session.", "openQuestions": [ "Does the checklist help teams who self-serve without sales?" ], "summary": { "narrative": "New teams consistently stall at configuration, especially the API-key step; those who get past it activate quickly.", "confidence": "high", "topThemeIds": [ "thm_setup", "thm_value" ], "suggestedNextQuestions": [ "What would have unblocked you fastest?" ], "stats": { "totalSourceItems": 24, "avgDuration": 712, "completionRate": 0.83, "avgQualityScore": 0.86 }, "lastUpdated": 1764687600000 }, "themes": [ { "themeId": "thm_setup", "label": "Setup friction", "description": "Confusion around where and how to configure credentials.", "sentiment": "negative", "strength": "strong", "trajectory": "rising", "distinctParticipants": 14, "preview": [ { "sourceItemId": "src_a1", "quote": "I gave up twice before I figured out where to add my API key.", "timeInCallSecs": 412, "relevance": 0.91, "participantName": "Ada L." } ] } ], "sourceItemCount": 24 }}