Engagement Survey

Summarize survey responses

AI summary of a survey's responses. Returns status ok with summary (plain text) and data (headline, overview, sentiment, findings with verbatim quotes that carry the response ticketId, themes, actions), not-enough-data below 3 responses, rate-limited within 60 seconds of the last attempt, or failed shortly after a failed attempt. A stored summary is returned without calling the model; refresh=true regenerates it (at most once per minute). outdated is true when responses arrived after it was generated. Uses up to the 999 newest responses within a 30,000-token budget. Consumes AI credits; 402 when the organisation is out of AI usage, 409 when generation fails and nothing is stored.

get/engagement/surveys/{surveyId}/responses/summarize

Path parameters

surveyIdstring required

Query parameters

refreshboolean

Headers

projectstring required

Response

Ok

{"stackTrail":"paths:/engagement/surveys/{surveyId}/responses/summarize:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes