Surveys-2

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

POST
POST
GET
POST
POST
GET
GET
GET

Create surveys responses archive

Archive a single survey response.

Required API key scopes

survey:write

Path parameters

  • id
    string
  • response_uuid
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
    stringnull
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
  • conditions
  • appearance
  • start_date
    stringnull
  • end_date
    stringnull
  • archived
    boolean
  • responses_limit
    integernull
  • iteration_count
    integernull
  • iteration_frequency_days
    integernull
  • iteration_start_dates
    arraynull
  • current_iteration
    integernull
  • current_iteration_start_date
    stringnull
  • response_sampling_start_date
    stringnull
  • response_sampling_interval_type
  • response_sampling_interval
    integernull
  • response_sampling_limit
    integernull
  • response_sampling_daily_limits
  • enable_partial_responses
    booleannull
  • enable_iframe_embedding
    booleannull
  • translations
  • _create_in_folder
    string
  • form_content

Example request

POST /api/projects/:project_id/surveys/:id/responses/:response_uuid/archive
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/responses/:response_uuid/archive/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Create surveys responses archive

Archive a single survey response.

Required API key scopes

survey:write

Path parameters

  • id
    string
  • response_uuid
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
    stringnull
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
  • conditions
  • appearance
  • start_date
    stringnull
  • end_date
    stringnull
  • archived
    boolean
  • responses_limit
    integernull
  • iteration_count
    integernull
  • iteration_frequency_days
    integernull
  • iteration_start_dates
    arraynull
  • current_iteration
    integernull
  • current_iteration_start_date
    stringnull
  • response_sampling_start_date
    stringnull
  • response_sampling_interval_type
  • response_sampling_interval
    integernull
  • response_sampling_limit
    integernull
  • response_sampling_daily_limits
  • enable_partial_responses
    booleannull
  • enable_iframe_embedding
    booleannull
  • translations
  • _create_in_folder
    string
  • form_content

Example request

POST /api/projects/:project_id/surveys/:id/responses/:response_uuid/archive
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/responses/:response_uuid/archive/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Create surveys responses unarchive

Unarchive a single survey response.

Required API key scopes

survey:write

Path parameters

  • id
    string
  • response_uuid
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
    stringnull
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
  • conditions
  • appearance
  • start_date
    stringnull
  • end_date
    stringnull
  • archived
    boolean
  • responses_limit
    integernull
  • iteration_count
    integernull
  • iteration_frequency_days
    integernull
  • iteration_start_dates
    arraynull
  • current_iteration
    integernull
  • current_iteration_start_date
    stringnull
  • response_sampling_start_date
    stringnull
  • response_sampling_interval_type
  • response_sampling_interval
    integernull
  • response_sampling_limit
    integernull
  • response_sampling_daily_limits
  • enable_partial_responses
    booleannull
  • enable_iframe_embedding
    booleannull
  • translations
  • _create_in_folder
    string
  • form_content

Example request

POST /api/projects/:project_id/surveys/:id/responses/:response_uuid/unarchive
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/responses/:response_uuid/unarchive/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Create surveys responses unarchive

Unarchive a single survey response.

Required API key scopes

survey:write

Path parameters

  • id
    string
  • response_uuid
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
    stringnull
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
  • conditions
  • appearance
  • start_date
    stringnull
  • end_date
    stringnull
  • archived
    boolean
  • responses_limit
    integernull
  • iteration_count
    integernull
  • iteration_frequency_days
    integernull
  • iteration_start_dates
    arraynull
  • current_iteration
    integernull
  • current_iteration_start_date
    stringnull
  • response_sampling_start_date
    stringnull
  • response_sampling_interval_type
  • response_sampling_interval
    integernull
  • response_sampling_limit
    integernull
  • response_sampling_daily_limits
  • enable_partial_responses
    booleannull
  • enable_iframe_embedding
    booleannull
  • translations
  • _create_in_folder
    string
  • form_content

Example request

POST /api/projects/:project_id/surveys/:id/responses/:response_uuid/unarchive
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/responses/:response_uuid/unarchive/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Retrieve surveys stats

Get survey response statistics for a specific survey.

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) exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived)

Returns: Survey statistics including event counts, unique respondents, and conversion rates

Required API key scopes

survey:read

Path parameters

  • id
    string

Query parameters

  • date_from
    string
  • date_to
    string

Response


Example request

GET /api/projects/:project_id/surveys/:id/stats
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/stats/

Example response

Status 200
RESPONSE
{
  "survey_id": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "stats": {},
  "rates": {}
}

Retrieve surveys stats

Get survey response statistics for a specific survey.

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) exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived)

Returns: Survey statistics including event counts, unique respondents, and conversion rates

Required API key scopes

survey:read

Path parameters

  • id
    string

Query parameters

  • date_from
    string
  • date_to
    string

Response


Example request

GET /api/projects/:project_id/surveys/:id/stats
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/stats/

Example response

Status 200
RESPONSE
{
  "survey_id": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "stats": {},
  "rates": {}
}

Create surveys summarize responses

Required API key scopes

survey:read

Path parameters

  • id
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
    stringnull
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
  • conditions
  • appearance
  • start_date
    stringnull
  • end_date
    stringnull
  • archived
    boolean
  • responses_limit
    integernull
  • iteration_count
    integernull
  • iteration_frequency_days
    integernull
  • iteration_start_dates
    arraynull
  • current_iteration
    integernull
  • current_iteration_start_date
    stringnull
  • response_sampling_start_date
    stringnull
  • response_sampling_interval_type
  • response_sampling_interval
    integernull
  • response_sampling_limit
    integernull
  • response_sampling_daily_limits
  • enable_partial_responses
    booleannull
  • enable_iframe_embedding
    booleannull
  • translations
  • _create_in_folder
    string
  • form_content

Example request

POST /api/projects/:project_id/surveys/:id/summarize_responses
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/summarize_responses/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Create surveys summarize responses

Required API key scopes

survey:read

Path parameters

  • id
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
    stringnull
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
  • conditions
  • appearance
  • start_date
    stringnull
  • end_date
    stringnull
  • archived
    boolean
  • responses_limit
    integernull
  • iteration_count
    integernull
  • iteration_frequency_days
    integernull
  • iteration_start_dates
    arraynull
  • current_iteration
    integernull
  • current_iteration_start_date
    stringnull
  • response_sampling_start_date
    stringnull
  • response_sampling_interval_type
  • response_sampling_interval
    integernull
  • response_sampling_limit
    integernull
  • response_sampling_daily_limits
  • enable_partial_responses
    booleannull
  • enable_iframe_embedding
    booleannull
  • translations
  • _create_in_folder
    string
  • form_content

Example request

POST /api/projects/:project_id/surveys/:id/summarize_responses
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/summarize_responses/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Create surveys summary headline

Required API key scopes

survey:read

Path parameters

  • id
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
    stringnull
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
  • conditions
  • appearance
  • start_date
    stringnull
  • end_date
    stringnull
  • archived
    boolean
  • responses_limit
    integernull
  • iteration_count
    integernull
  • iteration_frequency_days
    integernull
  • iteration_start_dates
    arraynull
  • current_iteration
    integernull
  • current_iteration_start_date
    stringnull
  • response_sampling_start_date
    stringnull
  • response_sampling_interval_type
  • response_sampling_interval
    integernull
  • response_sampling_limit
    integernull
  • response_sampling_daily_limits
  • enable_partial_responses
    booleannull
  • enable_iframe_embedding
    booleannull
  • translations
  • _create_in_folder
    string
  • form_content

Example request

POST /api/projects/:project_id/surveys/:id/summary_headline
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/summary_headline/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Create surveys summary headline

Required API key scopes

survey:read

Path parameters

  • id
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
    stringnull
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
  • conditions
  • appearance
  • start_date
    stringnull
  • end_date
    stringnull
  • archived
    boolean
  • responses_limit
    integernull
  • iteration_count
    integernull
  • iteration_frequency_days
    integernull
  • iteration_start_dates
    arraynull
  • current_iteration
    integernull
  • current_iteration_start_date
    stringnull
  • response_sampling_start_date
    stringnull
  • response_sampling_interval_type
  • response_sampling_interval
    integernull
  • response_sampling_limit
    integernull
  • response_sampling_daily_limits
  • enable_partial_responses
    booleannull
  • enable_iframe_embedding
    booleannull
  • translations
  • _create_in_folder
    string
  • form_content

Example request

POST /api/projects/:project_id/surveys/:id/summary_headline
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/summary_headline/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Retrieve surveys all activity

Required API key scopes

activity_log:read

Example request

GET /api/projects/:project_id/surveys/activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/activity/

Example response

Status 200 No response body

Retrieve surveys all activity

Required API key scopes

activity_log:read

Example request

GET /api/projects/:project_id/surveys/activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/activity/

Example response

Status 200 No response body

Retrieve surveys responses count

Get response counts for all surveys.

Args: exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived) survey_ids: Optional comma-separated list of survey IDs to filter by

Returns: Dictionary mapping survey IDs to response counts

Required API key scopes

survey:read

Example request

GET /api/projects/:project_id/surveys/responses_count
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/responses_count/

Example response

Status 200 No response body

Retrieve surveys responses count

Get response counts for all surveys.

Args: exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived) survey_ids: Optional comma-separated list of survey IDs to filter by

Returns: Dictionary mapping survey IDs to response counts

Required API key scopes

survey:read

Example request

GET /api/projects/:project_id/surveys/responses_count
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/responses_count/

Example response

Status 200 No response body

Retrieve surveys global stats

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

Required API key scopes

survey:read

Query parameters

  • date_from
    string
  • date_to
    string

Response


Example request

GET /api/projects/:project_id/surveys/stats
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/stats/

Example response

Status 200
RESPONSE
{
  "stats": {},
  "rates": {}
}

Retrieve surveys global stats

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

Required API key scopes

survey:read

Query parameters

  • date_from
    string
  • date_to
    string

Response


Example request

GET /api/projects/:project_id/surveys/stats
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/stats/

Example response

Status 200
RESPONSE
{
  "stats": {},
  "rates": {}
}
← Previous page

Community questions

Questions about this page? or post a community question.