{ "opencollection": "1.0.0", "info": { "name": "PostHog actions surveys API", "version": "1.0.0" }, "items": [ { "info": { "name": "surveys", "type": "folder" }, "items": [ { "info": { "name": "surveys_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/", "params": [ { "name": "archived", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_archived_response_uuids_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/archived-response-uuids/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get list of archived response UUIDs for HogQL filtering.\n\nReturns list of UUIDs that the frontend can use to filter out archived responses\nin HogQL queries." }, { "info": { "name": "surveys_duplicate_to_projects_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/duplicate_to_projects/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Duplicate a survey to multiple projects in a single transaction.\n\nAccepts a list of target team IDs and creates a copy of the survey in each project.\nUses an all-or-nothing approach - if any duplication fails, all changes are rolled back." }, { "info": { "name": "surveys_generate_translations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/generate_translations/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_responses_archive_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/responses/:response_uuid/archive/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "response_uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Archive a single survey response." }, { "info": { "name": "surveys_responses_unarchive_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/responses/:response_uuid/unarchive/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "response_uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Unarchive a single survey response." }, { "info": { "name": "surveys_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/stats/", "params": [ { "name": "date_from", "value": "", "type": "query", "description": "Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)" }, { "name": "date_to", "value": "", "type": "query", "description": "Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get survey response statistics for a specific survey.\n\nArgs:\n date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)\n date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)\n exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived)\n\nReturns:\n Survey statistics including event counts, unique respondents, and conversion rates" }, { "info": { "name": "surveys_summarize_responses_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/summarize_responses/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_summary_headline_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/summary_headline/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/activity/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_responses_count_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/responses_count/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get response counts for all surveys.\n\nArgs:\n exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived)\n survey_ids: Optional comma-separated list of survey IDs to filter by\n\nReturns:\n Dictionary mapping survey IDs to response counts" }, { "info": { "name": "surveys_global_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/stats/", "params": [ { "name": "date_from", "value": "", "type": "query", "description": "Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)" }, { "name": "date_to", "value": "", "type": "query", "description": "Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get aggregated response statistics across all surveys.\n\nArgs:\n date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)\n date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)\n\nReturns:\n Aggregated statistics across all surveys including total counts and rates" } ] } ], "bundled": true }