surveys

Summarize survey responses. When question_index or question_id is provided, returns a per-question theme summary using cached survey.question_summaries when fresh. When neither is provided, returns the survey-wide headline summary (delegates to summary_headline). Pass force_refresh=true in the body to bypass caches.

post/api/projects/{project_id}/surveys/{id}/summarize_responses/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/surveys/{id}/summarize_responses/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this survey.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

question_idstring

Question UUID. Preferred over question_index — stable across question edits.

question_indexinteger

Zero-based question index. Omit to get the survey-wide headline instead.

Request body

force_refreshboolean

When true, bypass cached summaries and regenerate. Defaults to false.

Response

No response body

Changes

No recorded changes to this operation across all 1 revision of this API.