surveys

Get aggregated response statistics across all surveys.

Args: date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z) date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)

Returns: Aggregated statistics across all surveys including total counts and rates

get/api/projects/{project_id}/surveys/stats/

Request

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

Path parameters

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

date_fromstring date-time

Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)

date_tostring date-time

Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)

Response

statsobject required

Event counts keyed by event name (survey shown, survey dismissed, survey sent).

ratesobject required

Calculated response and dismissal rates.

Changes

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