Survey

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

Endpoints

GET
POST
GET
PATCH
DELETE
GET
GET
POST
POST

List all surveys

Required API key scopes

survey:read

Query parameters

  • archived
    boolean
  • limit
    integer
  • offset
    integer
  • search
    string

Response


Example request

GET /api/projects/:project_id/surveys
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/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "type": "popover",
      "schedule": "string",
      "linked_flag": {
        "id": 0,
        "team_id": 0,
        "name": "string",
        "key": "string",
        "filters": {},
        "deleted": true,
        "active": true,
        "ensure_experience_continuity": true,
        "version": -2147483648,
        "evaluation_runtime": "server",
        "bucketing_identifier": "distinct_id",
        "evaluation_contexts": [
          "string"
        ]
      },
      "linked_flag_id": 0,
      "linked_insight_id": 0,
      "targeting_flag": {
        "id": 0,
        "team_id": 0,
        "name": "string",
        "key": "string",
        "filters": {},
        "deleted": true,
        "active": true,
        "ensure_experience_continuity": true,
        "version": -2147483648,
        "evaluation_runtime": "server",
        "bucketing_identifier": "distinct_id",
        "evaluation_contexts": [
          "string"
        ]
      },
      "internal_targeting_flag": {
        "id": 0,
        "team_id": 0,
        "name": "string",
        "key": "string",
        "filters": {},
        "deleted": true,
        "active": true,
        "ensure_experience_continuity": true,
        "version": -2147483648,
        "evaluation_runtime": "server",
        "bucketing_identifier": "distinct_id",
        "evaluation_contexts": [
          "string"
        ]
      },
      "questions": null,
      "conditions": {},
      "appearance": null,
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "start_date": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24T14:15:22Z",
      "archived": true,
      "responses_limit": 2147483647,
      "feature_flag_keys": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "iteration_count": 500,
      "iteration_frequency_days": 2147483647,
      "iteration_start_dates": [
        "2019-08-24T14:15:22Z"
      ],
      "current_iteration": 2147483647,
      "current_iteration_start_date": "2019-08-24T14:15:22Z",
      "response_sampling_start_date": "2019-08-24T14:15:22Z",
      "response_sampling_interval_type": "day",
      "response_sampling_interval": 2147483647,
      "response_sampling_limit": 2147483647,
      "response_sampling_daily_limits": null,
      "enable_partial_responses": true,
      "enable_iframe_embedding": true,
      "translations": null,
      "user_access_level": "string",
      "form_content": null
    }
  ]
}

List all surveys

Required API key scopes

survey:read

Query parameters

  • archived
    boolean
  • limit
    integer
  • offset
    integer
  • search
    string

Response


Example request

GET /api/projects/:project_id/surveys
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/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "type": "popover",
      "schedule": "string",
      "linked_flag": {
        "id": 0,
        "team_id": 0,
        "name": "string",
        "key": "string",
        "filters": {},
        "deleted": true,
        "active": true,
        "ensure_experience_continuity": true,
        "version": -2147483648,
        "evaluation_runtime": "server",
        "bucketing_identifier": "distinct_id",
        "evaluation_contexts": [
          "string"
        ]
      },
      "linked_flag_id": 0,
      "linked_insight_id": 0,
      "targeting_flag": {
        "id": 0,
        "team_id": 0,
        "name": "string",
        "key": "string",
        "filters": {},
        "deleted": true,
        "active": true,
        "ensure_experience_continuity": true,
        "version": -2147483648,
        "evaluation_runtime": "server",
        "bucketing_identifier": "distinct_id",
        "evaluation_contexts": [
          "string"
        ]
      },
      "internal_targeting_flag": {
        "id": 0,
        "team_id": 0,
        "name": "string",
        "key": "string",
        "filters": {},
        "deleted": true,
        "active": true,
        "ensure_experience_continuity": true,
        "version": -2147483648,
        "evaluation_runtime": "server",
        "bucketing_identifier": "distinct_id",
        "evaluation_contexts": [
          "string"
        ]
      },
      "questions": null,
      "conditions": {},
      "appearance": null,
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "start_date": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24T14:15:22Z",
      "archived": true,
      "responses_limit": 2147483647,
      "feature_flag_keys": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "iteration_count": 500,
      "iteration_frequency_days": 2147483647,
      "iteration_start_dates": [
        "2019-08-24T14:15:22Z"
      ],
      "current_iteration": 2147483647,
      "current_iteration_start_date": "2019-08-24T14:15:22Z",
      "response_sampling_start_date": "2019-08-24T14:15:22Z",
      "response_sampling_interval_type": "day",
      "response_sampling_interval": 2147483647,
      "response_sampling_limit": 2147483647,
      "response_sampling_daily_limits": null,
      "enable_partial_responses": true,
      "enable_iframe_embedding": true,
      "translations": null,
      "user_access_level": "string",
      "form_content": null
    }
  ]
}

Create surveys

Required API key scopes

survey:write

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
    Click to open
    arraynull
  • 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

Response


Example request

POST /api/projects/:project_id/surveys
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/\
	-d name="string",\
	-d type=undefined

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "type": "popover",
  "schedule": "string",
  "linked_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "linked_flag_id": 0,
  "linked_insight_id": 0,
  "targeting_flag_id": 0,
  "targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "internal_targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "targeting_flag_filters": null,
  "remove_targeting_flag": true,
  "questions": null,
  "conditions": null,
  "appearance": null,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "archived": true,
  "responses_limit": 2147483647,
  "iteration_count": 500,
  "iteration_frequency_days": 2147483647,
  "iteration_start_dates": [
    "2019-08-24T14:15:22Z"
  ],
  "current_iteration": 2147483647,
  "current_iteration_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_interval_type": "day",
  "response_sampling_interval": 2147483647,
  "response_sampling_limit": 2147483647,
  "response_sampling_daily_limits": null,
  "enable_partial_responses": true,
  "enable_iframe_embedding": true,
  "translations": null,
  "_create_in_folder": "string",
  "form_content": null
}

Create surveys

Required API key scopes

survey:write

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
    Click to open
    arraynull
  • 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

Response


Example request

POST /api/projects/:project_id/surveys
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/\
	-d name="string",\
	-d type=undefined

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "type": "popover",
  "schedule": "string",
  "linked_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "linked_flag_id": 0,
  "linked_insight_id": 0,
  "targeting_flag_id": 0,
  "targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "internal_targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "targeting_flag_filters": null,
  "remove_targeting_flag": true,
  "questions": null,
  "conditions": null,
  "appearance": null,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "archived": true,
  "responses_limit": 2147483647,
  "iteration_count": 500,
  "iteration_frequency_days": 2147483647,
  "iteration_start_dates": [
    "2019-08-24T14:15:22Z"
  ],
  "current_iteration": 2147483647,
  "current_iteration_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_interval_type": "day",
  "response_sampling_interval": 2147483647,
  "response_sampling_limit": 2147483647,
  "response_sampling_daily_limits": null,
  "enable_partial_responses": true,
  "enable_iframe_embedding": true,
  "translations": null,
  "_create_in_folder": "string",
  "form_content": null
}

Retrieve surveys

Required API key scopes

survey:read

Path parameters

  • id
    string

Response


Example request

GET /api/projects/:project_id/surveys/:id
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/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "type": "popover",
  "schedule": "string",
  "linked_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "linked_flag_id": 0,
  "linked_insight_id": 0,
  "targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "internal_targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "questions": null,
  "conditions": {},
  "appearance": null,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "archived": true,
  "responses_limit": 2147483647,
  "feature_flag_keys": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "iteration_count": 500,
  "iteration_frequency_days": 2147483647,
  "iteration_start_dates": [
    "2019-08-24T14:15:22Z"
  ],
  "current_iteration": 2147483647,
  "current_iteration_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_interval_type": "day",
  "response_sampling_interval": 2147483647,
  "response_sampling_limit": 2147483647,
  "response_sampling_daily_limits": null,
  "enable_partial_responses": true,
  "enable_iframe_embedding": true,
  "translations": null,
  "user_access_level": "string",
  "form_content": null
}

Retrieve surveys

Required API key scopes

survey:read

Path parameters

  • id
    string

Response


Example request

GET /api/projects/:project_id/surveys/:id
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/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "type": "popover",
  "schedule": "string",
  "linked_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "linked_flag_id": 0,
  "linked_insight_id": 0,
  "targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "internal_targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "questions": null,
  "conditions": {},
  "appearance": null,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "archived": true,
  "responses_limit": 2147483647,
  "feature_flag_keys": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "iteration_count": 500,
  "iteration_frequency_days": 2147483647,
  "iteration_start_dates": [
    "2019-08-24T14:15:22Z"
  ],
  "current_iteration": 2147483647,
  "current_iteration_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_interval_type": "day",
  "response_sampling_interval": 2147483647,
  "response_sampling_limit": 2147483647,
  "response_sampling_daily_limits": null,
  "enable_partial_responses": true,
  "enable_iframe_embedding": true,
  "translations": null,
  "user_access_level": "string",
  "form_content": null
}

Update surveys

Required API key scopes

survey:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
    Click to open
    arraynull
  • 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

Response


Example request

PATCH /api/projects/:project_id/surveys/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "type": "popover",
  "schedule": "string",
  "linked_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "linked_flag_id": 0,
  "linked_insight_id": 0,
  "targeting_flag_id": 0,
  "targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "internal_targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "targeting_flag_filters": null,
  "remove_targeting_flag": true,
  "questions": null,
  "conditions": null,
  "appearance": null,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "archived": true,
  "responses_limit": 2147483647,
  "iteration_count": 500,
  "iteration_frequency_days": 2147483647,
  "iteration_start_dates": [
    "2019-08-24T14:15:22Z"
  ],
  "current_iteration": 2147483647,
  "current_iteration_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_interval_type": "day",
  "response_sampling_interval": 2147483647,
  "response_sampling_limit": 2147483647,
  "response_sampling_daily_limits": null,
  "enable_partial_responses": true,
  "enable_iframe_embedding": true,
  "translations": null,
  "_create_in_folder": "string",
  "form_content": null
}

Update surveys

Required API key scopes

survey:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • description
    string
  • type
  • schedule
  • linked_flag_id
    integernull
  • linked_insight_id
    integernull
  • targeting_flag_id
    integer
  • targeting_flag_filters
  • remove_targeting_flag
    booleannull
  • questions
    Click to open
    arraynull
  • 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

Response


Example request

PATCH /api/projects/:project_id/surveys/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/surveys/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "type": "popover",
  "schedule": "string",
  "linked_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "linked_flag_id": 0,
  "linked_insight_id": 0,
  "targeting_flag_id": 0,
  "targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "internal_targeting_flag": {
    "id": 0,
    "team_id": 0,
    "name": "string",
    "key": "string",
    "filters": {},
    "deleted": true,
    "active": true,
    "ensure_experience_continuity": true,
    "version": -2147483648,
    "evaluation_runtime": "server",
    "bucketing_identifier": "distinct_id",
    "evaluation_contexts": [
      "string"
    ]
  },
  "targeting_flag_filters": null,
  "remove_targeting_flag": true,
  "questions": null,
  "conditions": null,
  "appearance": null,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "archived": true,
  "responses_limit": 2147483647,
  "iteration_count": 500,
  "iteration_frequency_days": 2147483647,
  "iteration_start_dates": [
    "2019-08-24T14:15:22Z"
  ],
  "current_iteration": 2147483647,
  "current_iteration_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_start_date": "2019-08-24T14:15:22Z",
  "response_sampling_interval_type": "day",
  "response_sampling_interval": 2147483647,
  "response_sampling_limit": 2147483647,
  "response_sampling_daily_limits": null,
  "enable_partial_responses": true,
  "enable_iframe_embedding": true,
  "translations": null,
  "_create_in_folder": "string",
  "form_content": null
}

Delete surveys

Required API key scopes

survey:write

Path parameters

  • id
    string

Example request

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

Example response

Status 204 No response body

Delete surveys

Required API key scopes

survey:write

Path parameters

  • id
    string

Example request

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

Example response

Status 204 No response body

Retrieve surveys activity

Required API key scopes

activity_log:read

Path parameters

  • id
    string

Example request

GET /api/projects/:project_id/surveys/:id/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/:id/activity/

Example response

Status 200 No response body

Retrieve surveys activity

Required API key scopes

activity_log:read

Path parameters

  • id
    string

Example request

GET /api/projects/:project_id/surveys/:id/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/:id/activity/

Example response

Status 200 No response body

Retrieve surveys archived response uuids

Get list of archived response UUIDs for HogQL filtering.

Returns list of UUIDs that the frontend can use to filter out archived responses in HogQL queries.

Required API key scopes

survey:read

Path parameters

  • id
    string

Example request

GET /api/projects/:project_id/surveys/:id/archived-response-uuids
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/archived-response-uuids/

Example response

Status 200 No response body

Retrieve surveys archived response uuids

Get list of archived response UUIDs for HogQL filtering.

Returns list of UUIDs that the frontend can use to filter out archived responses in HogQL queries.

Required API key scopes

survey:read

Path parameters

  • id
    string

Example request

GET /api/projects/:project_id/surveys/:id/archived-response-uuids
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/archived-response-uuids/

Example response

Status 200 No response body

Create surveys duplicate to projects

Duplicate a survey to multiple projects in a single transaction.

Accepts a list of target team IDs and creates a copy of the survey in each project. Uses an all-or-nothing approach - if any duplication fails, all changes are rolled back.

Required API key scopes

survey:write

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/duplicate_to_projects
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/duplicate_to_projects/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Create surveys duplicate to projects

Duplicate a survey to multiple projects in a single transaction.

Accepts a list of target team IDs and creates a copy of the survey in each project. Uses an all-or-nothing approach - if any duplication fails, all changes are rolled back.

Required API key scopes

survey:write

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/duplicate_to_projects
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/duplicate_to_projects/\
	-d name="string",\
	-d type=undefined

Example response

Status 200 No response body

Create surveys generate translations

Required API key scopes

survey:write

Path parameters

  • id
    string

Request parameters

  • target_language
    string
  • source_language
    string
    Default: en
  • overwrite
    boolean
    Default: false
  • survey
    object

Response


Example request

POST /api/projects/:project_id/surveys/:id/generate_translations
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/generate_translations/\
	-d target_language="string"

Example response

Status 200
RESPONSE
{
  "translations": {
    "property1": {
      "name": "string",
      "thankYouMessageHeader": "string",
      "thankYouMessageDescription": "string",
      "thankYouMessageCloseButtonText": "string"
    },
    "property2": {
      "name": "string",
      "thankYouMessageHeader": "string",
      "thankYouMessageDescription": "string",
      "thankYouMessageCloseButtonText": "string"
    }
  },
  "questions": [
    {
      "id": "string",
      "translations": {
        "property1": {
          "question": "string",
          "description": "string",
          "buttonText": "string",
          "choices": [
            "string"
          ],
          "lowerBoundLabel": "string",
          "upperBoundLabel": "string",
          "link": "string"
        },
        "property2": {
          "question": "string",
          "description": "string",
          "buttonText": "string",
          "choices": [
            "string"
          ],
          "lowerBoundLabel": "string",
          "upperBoundLabel": "string",
          "link": "string"
        }
      }
    }
  ],
  "generated_field_paths": [
    "string"
  ],
  "trace_id": "string"
}

Create surveys generate translations

Required API key scopes

survey:write

Path parameters

  • id
    string

Request parameters

  • target_language
    string
  • source_language
    string
    Default: en
  • overwrite
    boolean
    Default: false
  • survey
    object

Response


Example request

POST /api/projects/:project_id/surveys/:id/generate_translations
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/generate_translations/\
	-d target_language="string"

Example response

Status 200
RESPONSE
{
  "translations": {
    "property1": {
      "name": "string",
      "thankYouMessageHeader": "string",
      "thankYouMessageDescription": "string",
      "thankYouMessageCloseButtonText": "string"
    },
    "property2": {
      "name": "string",
      "thankYouMessageHeader": "string",
      "thankYouMessageDescription": "string",
      "thankYouMessageCloseButtonText": "string"
    }
  },
  "questions": [
    {
      "id": "string",
      "translations": {
        "property1": {
          "question": "string",
          "description": "string",
          "buttonText": "string",
          "choices": [
            "string"
          ],
          "lowerBoundLabel": "string",
          "upperBoundLabel": "string",
          "link": "string"
        },
        "property2": {
          "question": "string",
          "description": "string",
          "buttonText": "string",
          "choices": [
            "string"
          ],
          "lowerBoundLabel": "string",
          "upperBoundLabel": "string",
          "link": "string"
        }
      }
    }
  ],
  "generated_field_paths": [
    "string"
  ],
  "trace_id": "string"
}
Next page →

Community questions

Questions about this page? or post a community question.