PostHog · Schema

SurveyStatsResponse

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
survey_id	string	The survey ID these stats belong to.
start_date	string	When the survey started collecting responses.
end_date	string	When the survey stopped collecting responses.
stats	object	Event counts keyed by event name (survey shown, survey dismissed, survey sent).
rates	object	Calculated response and dismissal rates.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SurveyStatsResponse",
  "title": "SurveyStatsResponse",
  "type": "object",
  "properties": {
    "survey_id": {
      "type": "string",
      "description": "The survey ID these stats belong to."
    },
    "start_date": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the survey started collecting responses."
    },
    "end_date": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the survey stopped collecting responses."
    },
    "stats": {
      "type": "object",
      "additionalProperties": true,
      "description": "Event counts keyed by event name (survey shown, survey dismissed, survey sent)."
    },
    "rates": {
      "type": "object",
      "additionalProperties": true,
      "description": "Calculated response and dismissal rates."
    }
  },
  "required": [
    "end_date",
    "rates",
    "start_date",
    "stats",
    "survey_id"
  ]
}